admin/beefproject-beef
1
0
Fork 0
mirror of https://github.com/beefproject/beef synced 2026-06-08 13:15:56 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: Installation
Pages
ActiveRecord Architecture Autorun Rule Engine Basics BeEF Console BeEF RESTful API BeEF Testing BeEF modules Browser & OS Compatibility Command Module API Command Module Config Configuration Creating An Extension Database Schema Development Organization Docker Setup FAQ Fetch_Port_Scanner Form Data Types Geolocation Home How BeEF Works Information Gathering Installation Interface Introducing BeEF Javascript API Linksys WRT54G2 CSRF MAC OSX installation using RVM Metasploit Milestones Module Creation Steps Module Creation Module Start Recording Audio Module: 3COM OfficeConnect Command Execution Module: AJAX Fingerprint Module: ActiveX Command Execution Module: Alert Dialog Module: AlienVault OSSIM 3.1 XSS Module: Asmax AR 804gu Command Execution Module: Autocomplete Theft Module: BT Home Hub CSRF Module: Beep Module: Bindshell (POSIX) Module: Bindshell (Windows) Module: Check connection Module: Cisco Collaboration Server 5 XSS Module: Cisco E2400 CSRF Module: Clickjacking Module: Clippy Module: ColdFusion Directory Traversal Exploit Module: Comtrend CT 5367 CSRF Module: Comtrend CT 5624 CSRF Module: Confirm Close Tab Module: Create Alert Dialog Module: Create Foreground iFrame Module: Create Invisible Iframe Module: Create Pop Under Module: Create Prompt Dialog Module: Cross Site Printing (XSP) Module: D Link DIR 615 Password Wipe Module: D Link DSL500T CSRF Module: DNS Enumeration Module: DNS Tunnel Module: Deface Web Page Module: Detect CUPS Module: Detect Extensions Module: Detect Firebug Module: Detect Google Desktop Module: Detect LastPass Module: Detect PhoneGap Module: Detect Popup Blocker Module: Detect Social Networks Module: Detect Software Module: Detect TOR Module: Detect Unsafe ActiveX Module: Detect Visited URL Module: Dlink DCS series CSRF Module: Execute On Tab Module: Fake Evernote Web Clipper Login Module: Fake Flash Update Module: Fake LastPass Module: Fake Notification Bar (Chrome) Module: Fake Notification Bar (FF) Module: Fake Notification Bar (IE) Module: Fake Notification Bar Module: Fingerprint Network Module: Geolocation Module: Get All Cookies Module: Get Clipboard Module: Get Cookie Module: Get Geolocation Module: Get Internal IP (Java) Module: Get Internal IP WebRTC Module: Get Local Storage Module: Get Page HTML Module: Get Page Links Module: Get Protocol Handlers Module: Get Registry Keys Module: Get Session Storage Module: Get Stored Credentials Module: Get System Info (Java) Module: Get Visited Domains Module: Get Wireless Keys Module: GlassFish WAR Upload XSRF Module: Google Phishing Module: Grab Google Contacts Module: Hook Default Browser Module: Huawei SmartAX MT880 CSRF Module: IMAP Module: IRC NAT Pinning Module: IRC Module: Inject BeEF Module: Java Payload Module: Jboss 6.0.0M1 JMX Deploy Exploit Module: Lcamtuf Download Module: Link Rewrite (Clicked Event) Module: Link Rewrite (HTTPS) Module: Link Rewrite (TEL) Module: Link Rewrite Module: Linksys BEFSR41 CSRF Module: Linksys WRT54G CSRF Module: Linksys WVC series CSRF Module: List Files Module: Local File Theft Module: Make Telephone Call Module: Man In The Browser Module: Netgear GS108T CSRF Module: Persist resume Module: Persistence Module: Ping Sweep (FF) Module: Ping Sweep (Java) Module: Ping Sweep Module: Play Sound Module: Port Scanner Module: Pretty Theft Module: Raw Javascript Module: Redirect Browser (Rickroll) Module: Redirect Browser (iFrame) Module: Redirect Browser Module: Replace Component (Deface) Module: Replace Videos Module: Return Ascii Chars Module: Safari Launch App Module: Screenshot Module: Send Gvoice SMS Module: Serendipity = 1.1.1 Add User CSRF Module: Simple Hijacker Module: Spring Framework Malicious Jar Exploit Module: Start Recording Audio Module: Stop Recording Audio Module: TabNabbing Module: Test Network Request Module: Test Returning Results Module: Unhook Module: Upload File Module: VTiger CRM Upload Exploit Module: Virgin Superhub CSRF Module: Webcam Module: Windows Mail Client DoS Module: Zenoss 3.2.1 Add User CSRF Module: Zenoss 3.2.1 Daemon CSRF Module: boastMachine 3.1 Add User CSRF Module: browser fingerprint Module: detect bitdefender2012 Module: detect office Module: iFrame Event Key Logger Module: iFrame Sniffer Module: iOS Address Bar Spoofing Network Discovery Notifications Other Persistence Postman Proxy and requester extension References Release Notes RuboCop Script: Java 1.6.0u27 mass pwner Social Engineering Troubleshooting Tunneling Using BeEF With NGROK WebRTC Extension XSS Rays
Clone
58
Installation
bcoles edited this page 2023-04-01 15:41:50 +11:00
Table of Contents

Introduction

The following installation instructions are suitable for Linux based operating systems.

In theory, BeEF should work on any operating system which can run Ruby 3.0+ and NodeJS. However, only MacOS and Linux are officially supported.

You will not find MacOS installation instructions in this guide.

Alternatively, running BeEF through Docker alleviates any host setup pains. Refer to the Docker Setup instructions.

Table of Contents

Prerequisites

Ruby

BeEF requires Ruby 3.0 (or newer). Refer to your operating system documentation for instructions to install the latest stable version of Ruby and Ruby Developer Tools.

If your operating system package manager does not support Ruby version 3.0 (or newer), 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.

These are command line tools that allow for simple management of different Ruby environments.

Bundler

Bundler is essential for tracking and installing the correct gems in ruby projects.

$ gem install bundler

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

Installation

Once a suitable version of Ruby is installed, run the install script in the BeEF directory:

$ ./install

This script installs the required operating system packages, NodeJS, 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.

Start BeEF

To start BeEF, first change the username and password config.yaml and then simply run:

  $ ./beef

Testing

If you want to install the test pre-requisites just run:

$ sudo apt-get install espeak lame
$ bundle install --with test

This will install the pre-requisite gems for tests.

If you want to run the test suit run:

$ bundle exec rake

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 manually with

$ git pull
$ bundle install

Introducing BeEF | Configuration

I - Starting BeEF

  1. Introducing BeEF
  2. Installation
  3. Basics
  4. Troubleshooting

II - Basic Utilization

  1. Configuration
  2. Interface
  3. Information Gathering
  4. Social Engineering
  5. Network Discovery
  6. Metasploit
  7. Tunneling
  8. XSS Rays
  9. Persistence
  10. Creating a Module
  11. Geolocation
  12. Using-BeEF-With-NGROK

III - Advanced Utilization

  1. RESTful API
  2. Autorun Rule Engine
  3. Notifications
  4. Console
  5. WebRTC Extension

IV - Development

  1. Contributing
  2. ActiveRecord
  3. Development Organization
  4. Architecture
  5. BeEF Javascript API
  6. Step By Step Module Creation
  7. Creating a New Extension
  8. BeEF Testing
  9. Browser & OS Compatibility
  10. Database Schema
  11. Development Milestones
  12. Command Module Config
  13. Command Module API

V - References

  1. FAQ
  2. Other
  3. References
  4. Modules
  5. Release Notes

User Guide

I. Introduction   |   II. Basic Utilization   |   III. Advanced Utilization   |   IV. Development   |   V. References

Community

Blog   |   Code   |   Youtube   |   Twitter