# Technical Documentation: beefproject/beef > ℹ️ **Provenance:** Multi-Tier Ingestion · [CodeWiki Reference](https://codewiki.google/github.com/beefproject/beef) ### Overview (`README.md`) =============================================================================== 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 ``` --- ### Overview (`spec/README.md`) # BeEF Test Suite This directory contains the BeEF test suite using RSpec and SimpleCov for comprehensive testing and coverage reporting. ## Setup ### Prerequisites - Ruby 3.0+ - Bundler - All gems from `Gemfile` ### Configuration Files - `spec/spec_helper.rb` - Main test configuration - `.simplecov` - Coverage configuration - `spec/support/` - Test helpers and utilities ## Running Tests ### Basic Commands ```bash # Run all tests (fast, no coverage) bundle exec rake short # or bundle exec rspec spec/ --tag '~run_on_browserstack' --tag '~run_on_long_tests' # Run specific component tests bundle exec rspec spec/beef/core/ bundle exec rspec spec/beef/extensions/ bundle exec rspec spec/beef/modules/ ``` ### Coverage Commands ```bash # Complete coverage (recommended) bundle exec rake coverage # or COVERAGE=all bundle exec rspec spec/ --tag '~run_on_browserstack' --tag '~run_on_long_tests' # Component-specific coverage bundle exec rake coverage_core # Core only bundle exec rake coverage_modules # Modules only bundle exec rake coverage_extensions # Extensions only ``` ### Legacy Commands (Still Supported) ```bash # Old coverage commands still work bundle exec rake coverage:modules bundle exec rake coverage:all bundle exec rake coverage_complete ``` ## Architecture ### SimpleCov Configuration - **Environment-based**: Uses `COVERAGE=core|modules|extensions|all` environment variable - **Grouped reporting**: Separate groups for Core, Extensions, and Modules - **Filtered tracking**: Only tracks relevant files based on focus area - **HTML reports**: Generated in `coverage/` directory ### Test Organization - **Centralized config**: `BeefTestConfig` module provides test data instead of global constants - **Component isolation**: Each component (core/extensions/modules) has dedicated specs - **Branch coverage**: Realistic test data for conditional logic testing - **Mock management**: Proper mocking of external dependencies ### Rake Tasks - **Clean separation**: Base `spec*` tasks vs coverage `coverage*` tasks - **Environment variables**: Coverage controlled via `COVERAGE` env var - **No sequential execution**: Single test runs with proper filtering - **Backward compatibility**: Old task names still work ## Key Improvements ### ✅ **Eliminated Global Constant Collisions** - Branch-coverage data for the dynamic module spec loaders lives in `BeefTestConfig.branch_coverage_for(:component)` (in `spec/spec_helper.rb`). - Each module spec file pulls its own component (`:browser`, `:exploits`, `:host`, `:misc`, `:network`, `:social_engineering`) into a uniquely-named local constant (e.g. `BRANCH_COVERAGE_HOST`), so loading the full suite no longer triggers "already initialized constant" warnings or silently overwrites data. ### ✅ **Simplified Coverage Logic** - Cleaner filtering using `track_files` instead of complex `add_filter` logic - Environment variable `COVERAGE` instead of `COVERAGE_FOCUS` ### ✅ **Better Test Organization** - Centralized test configuration in `BeefTestConfig` - Component-specific test data loading - Reduced code duplication ### ✅ **Cleaner Rake Tasks** - Single execution instead of sequential runs - Proper environment variable usage - Backward compatibility maintained ### ✅ **Standard Patterns** - Uses `.simplecov` config file (standard practice) - Follows RSpec best practices - Better separation of concerns ## Module Spec Pattern (dynamic loaders) Specs under `spec/beef/modules/**/_spec.rb` walk every `modules//**/module.rb` file and generate a `RSpec.describe` block per class. They cover: - `.options` returns an `Array` (when defined) - `#pre_send` runs without raising (when defined) - `#post_execute` runs without raising (when defined) - An extra `#post_execute` example with a realistic datastore for any module listed in `BeefTestConfig.branch_coverage_for(:category)` Trade-off: this is a coverage-driving baseline. The `expect { ... }.not_to raise_error` assertion catches load failures, missing constants, nil crashes, and undefined methods, but it does not assert behavioural correctness. Add targeted assertions for high-value modules (see the `Wordpress_add_user` and `Test_get_variable` examples in `spec/beef/modules/misc/misc_spec.rb`). ## Coverage Focus Areas - **core**: Framework core functionality - **extensions**: Extension modules - **modules**: Command modules (main focus) - **all**: Complete coverage across all areas ## Troubleshooting ### Common Issues 1. **"already initialized constant" warnings** - Fixed by using centralized config instead of global constants 2. **Low coverage percentages** - Use `COVERAGE=all` for complete coverage - Ensure realistic test data triggers conditional paths 3. **Test failures** - Check that mocks are properly configured - Verify test data matches module expectations ### Debug Commands ```bash # Run with debug output bundle exec rspec --format documentation # Run single test file bundle exec rspec spec/beef/modules/browser/browser_spec.rb # Check coverage report open coverage/index.html ``` ## Contributing When adding new tests: 1. Use `BeefTestConfig.branch_coverage_for(:component)` for branch test data 2. Add realistic datastore values that trigger conditional logic 3. Mock external dependencies (database, network, etc.) 4. Follow existing patterns for consistency --- ### Overview (`modules/network/dns_rebinding/README.md`) # Manual to DNS Rebinding (aka Anti DNS Pinning aka multiple A record) attack # ## How does attack work in general? ## Attacker must have some domain and DNS server responds to DNS query for this domain. When client's browser connects to the attacker's domain it gets two IP addresses: * First IP address in the DNS response is address of Web page with malicious JavaScript. * Second IP address is from victim's LAN, it is a target address. The client's browser connects to the first IP address in the DNS response and retrieves the HTML file containing the attacker's JavaScript. When the attacker's JavaScript initiates a request back to the attacker's domain via an XMLHttpRequest, the browser will again try to connect to the attacker's Web server. However, since the client's IP is now blocked, the browser will receive a TCP reset packet from the attacker's Web server. The browser will automatically attempt to use the second IP address listed in the DNS response, which is the IP address of the client’s router. The attacker's JavaScript can now send requests to the router as well as view the responses. ## How to launch attack in BeEF? ## 1. First of all, you should register domain, for example *dnsrebinding.org* and register NS server with IP address where BeEF DNS server launched. For tests you can use https://freedns.afraid.org, free third-level domain registrar. 2. Configure DNS Rebinding extension and module. In extension there are four main configs: * *address_http_internal* - IP Address of small HTTP Server, that hooks victim. That address will be in DNS response for victim. * *address_http_external* - If you behind NAT * *address_proxy_internal* - Victim will send on that address responses from target LAN IP. May be the same as address_http. * *address_proxy_external* - If you behind NAT * *port_ proxy* - 81 by default In module main config is *domain*. Module adds DNS rule to BeEF DNS database with the help of this config. 3. Hook victim by help of link contains new registered domain, for example *http://dnsrebinding.org* 4. In BeEF UI open module "DNS Rebinding" and fill *target* field. (That is target IP from victim's LAN, for example 192.168.0.1) Then launch module for hooked browser. Module adds DNS rule with double A record in BeEF DNS database and sends JS. 4. Victim's browser will send query to small HTTP Server of DNS Rebinding extension. Then extension block IP with the help of iptables. Then victim's browser will initiate second XMLHttpRequest to page. And that will be query to target IP. Then sends response from target IP to DNS Rebinding Proxy server. 5. Open in your browser page http://address_proxy:port_proxy/**path**, where **path** is path you want get from target IP. For example, if **path** = **login.html** and target IP is 192.168.0.1 you get HTML page from victim's router, the same as http://192.168.0.1/login.php 6. That is all. Extension uses Iptables to block client. That is no good way, because system() is patched and Iptables need sudo. But victim's browser need get TCP RST from server right away XMLHttpRequest to successful attack. Notice, attack is VERY DEMANDING, there are many things that can break it. For example: 1. If victim's browser already have established connection with target IP in other tab, when browser gets DNS response from BeEF DNS server it will use second (local) IP address instead of public address. 2. If victim's browser have unclear cache with target IP address, browser will use local IP. 3. (!) If victim even has closed, TIME WAIT connection with target IP address - the same, browser will use local IP 4. If victim broke attack (for example close tab with hook page), browser anyway save in cache ip address (local) of web page, and you should wait some time while cache will be clear again. In different browsers that time different. ## References ## 1. http://en.wikipedia.org/wiki/DNS_rebinding 1. https://code.google.com/p/rebind/downloads/list - DNS Rebinding tool implemented on C. Very good explanation of attack in archive: /docs/whitepaper.pdf --- ### Overview (`modules/exploits/beefbind/shellcode_sources/msf/README.md`) # Metasploit BeEF Bind Payloads Note: the paths specified below relate to the Metasploit installation directory on Kali Linux. The paths may differ on your system. ## Install Handler Installing BeEF Bind payloads requires also installing a custom handler into framework: ```sh sudo cp beef_bind-handler.rb /usr/share/metasploit-framework/lib/msf/core/handler/beef_bind.rb ``` ## Install Payloads Payloads can be installed into the Metasploit Framework installation directory (for all users) or user's home directory `~/.msf4/modules/payloads/...`. ```sh cp beef_bind-stage-windows-x86.rb /usr/share/metasploit-framework/modules/payloads/stages/windows/beef_shell.rb cp beef_bind-stager-windows-x86.rb /usr/share/metasploit-framework/modules/payloads/stagers/windows/beef_bind.rb cp beef_bind-stage-linux-x86.rb /usr/share/metasploit-framework/modules/payloads/stages/linux/x86/beef_shell.rb cp beef_bind-stager-linux-x86.rb /usr/share/metasploit-framework/modules/payloads/stagers/linux/x86/beef_bind.rb cp beef_bind-stage-linux-x64.rb /usr/share/metasploit-framework/modules/payloads/stages/linux/x64/beef_shell.rb cp beef_bind-stager-linux-x64.rb /usr/share/metasploit-framework/modules/payloads/stagers/linux/x64/beef_bind.rb ``` ## Generating Payloads Check it works: ```sh msfvenom -l payloads | grep beef_bind ``` Dump stager and stage in C format: ```sh msfvenom -p windows/beef_shell/beef_bind --format C ``` Dump stager in raw format: ```sh msfvenom -p windows/beef_shell/beef_bind R > beef_bind-stager ``` Encode stager to remove nulls: ```sh msfvenom -p windows/beef_shell/beef_bind R --bad-chars '\x00' > beef_bind-stager-nonull ``` --- ### Scripts Prettify Apache License 2.0 (`docs/scripts/prettify/Apache-License-2.0.txt`) Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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. --- --- METRICS --- - Files Extracted: 5 - Estimated Token Budget: ~6418 tokens - Canonical Reference: https://codewiki.google/github.com/beefproject/beef