beefproject/beef repository overview

⁠BeEF

===============================================================================

Copyright (c) 2006-2020 Wade Alcorn - [email protected]
Browser Exploitation Framework (BeEF) - http://beefproject.com
See the source code file 'doc/COPYING' @ beefproject/beef on Github for copying permission

===============================================================================

⁠What is BeEF?

BeEF is short for The Browser Exploitation Framework.

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.

⁠Quick Start

Please see the Installation Wiki⁠ page for more detailed installation instructions

⁠Download the Source Code

git clone https://github.com/beefproject/beef  

⁠Setting Your Credentials

It is essential that you set your credentials BEFORE building your Docker image. BeEF by default has it's credentials set to beef:beef, but does not allow authentication with default credentials. Consequently if you build an image without changing the credentials you will not be able to authenticate your container's BeEF instance.

With your preferred text editor open the config.yaml file found in the BeEF root folder:

  ...SNIP...
    credentials:
      user: '<YOUR_USERNAME>'
      passwd: '<YOUR_PASSWORD>'
  ...SNIP...

⁠Building Your Image & Container

To build your image:

  $ docker build -t beef .

To run your container:

  # If you'd prefer the container to run backgrounded/detached just add the -d tag to the command below
  $ docker run -p 3000:3000 -p 6789:6789 -p 61985:61985 -p 61986:61986 --name beef beef

⁠Contribute to BeEF

The BeEF project uses GitHub to track issues and host its git repository. To checkout a read only copy of the repository you can issue the command below:

git clone https://github.com/beefproject/beef  

To checkout a non-read only copy or for more information please refer to BeEF GitHub page⁠.