Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
0xmachos authored Mar 9, 2018
2 parents 13d24bf + cf6a720 commit 633ccdd
Show file tree
Hide file tree
Showing 35 changed files with 1,057 additions and 524 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,5 @@ $RECYCLE.BIN/
# Project-level settings
/.tgitconfig

test/thirdparty/msf/unit/.byebug_history
/load
40 changes: 20 additions & 20 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ gem 'eventmachine'
gem 'thin'
gem 'sinatra'
gem 'rack', '~> 1.6.5'
gem 'rack-protection', '~> 1.5.4'
gem 'em-websocket' # WebSocket support
gem 'uglifier'
gem 'mime-types'
Expand All @@ -22,6 +23,7 @@ gem 'data_objects'
gem 'rubyzip', '>= 1.2.1'
gem 'espeak-ruby', '>= 1.0.4' # Text-to-Voice
gem 'nokogiri', '>= 1.7'
gem 'rake'

if RUBY_PLATFORM.downcase.include?('linux')
gem 'therubyracer', '~> 0.12.2', '<= 0.12.2'
Expand Down Expand Up @@ -69,9 +71,6 @@ end
# DNS extension
group :ext_dns do
gem 'rubydns', '~> 0.7.3'
# rubydns requires rainbow
# which requires rake, but doesn't specify rake as a dependency
gem 'rake'
end

# network extension
Expand All @@ -86,23 +85,24 @@ end

# For running unit tests
group :test do
if ENV['BEEF_TEST']
gem 'rake'
gem 'test-unit'
gem 'test-unit-full'
gem 'curb'
gem 'selenium'
# selenium-webdriver 3.x is incompatible with Firefox version 48 and prior
gem 'selenium-webdriver', '~> 2.53.4'
gem 'rspec'
gem 'bundler-audit'
# nokogirl is needed by capybara which may require one of the below commands
# sudo apt-get install libxslt-dev libxml2-dev
# sudo port install libxml2 libxslt
gem 'capybara'
# RESTful API tests/generic command module tests
gem 'rest-client', '>= 2.0.1'
end
if ENV['BEEF_TEST']
gem 'test-unit'
gem 'test-unit-full'
gem 'rspec'
# curb gem requires curl libraries
# sudo apt-get install libcurl4-openssl-dev
gem 'curb'
# selenium-webdriver 3.x is incompatible with Firefox version 48 and prior
gem 'selenium'
gem 'selenium-webdriver', '~> 2.53.4'
# nokogirl is needed by capybara which may require one of the below commands
# sudo apt-get install libxslt-dev libxml2-dev
# sudo port install libxml2 libxslt
gem 'capybara'
# RESTful API tests/generic command module tests
gem 'rest-client', '>= 2.0.1'
gem 'byebug'
end
end

source 'https://rubygems.org'
177 changes: 0 additions & 177 deletions Gemfile.lock

This file was deleted.

106 changes: 37 additions & 69 deletions INSTALL.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,98 +6,66 @@

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

Installation
------------
Source
------

Obtain application source code either by downloading the latest archive:

$ wget https://github.com/beefproject/beef/archive/master.zip

1. Prerequisites (platform independent)
2. Prerequisites (Windows)
3. Prerequisites (Linux)
4. Prerequisites (Mac OSX)
5. Install instructions
6. Run instructions
Or cloning the Git repository from Github:

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


1. Prerequisites (platform independent)
Prerequisites
--------------

BeEF requires Ruby 2.2+ and the "bundler" gem. Bundler can be installed by:
BeEF requires Ruby 2.3+.

gem install bundler
If your operating system package manager does not support Ruby version 2.3,
you can add the brightbox ppa repository for the latest version of Ruby:


2. Prerequisites (Windows)
$ sudo apt-add-repository -y ppa:brightbox/ruby-ng

Windows is no longer supported. The following instructions are outdated.
Alternatively, consider using a Ruby environment manager such as rbenv or rvm
to manager your Ruby versions. Refer to the following for more information:

!!! This must be done PRIOR to running the bundle install command !!!

Windows requires the sqlite.dll. Simply grab the zip file below and extract it to your Ruby bin directory:
* rbenv: https://github.com/rbenv/rbenv
* rvm: https://rvm.io/rvm/install'

http://www.sqlite.org/sqlitedll-3_7_0_1.zip

Other than that, you also need TheRubyRacer. As it's painful to install it on Windows, you can download 2 pre-compiled V8 DLLs and 2 gems from https://github.com/eakmotion/therubyracer_for_windows.
Installation
------------

Finally, edit beef's gem lock file by replacing the required ruby racer version with the version downloaded from the link above.
Once Ruby is installed, run the install script in the BeEF directory:

3. Prerequisites (Linux)
./install

!!! This must be done PRIOR to running the bundle install command !!!
This script installs the required operating system packages and all the
prerequisite Ruby gems.

On linux you will need to find the packages specific to your distribution for sqlite. An example build script for Ubuntu 14.04 systems is:
Upon successful installation, be sure to read the Configuration page
on the wiki for important details on configuring and securing BeEF.

# Set your prefered build dir
BUILDDIR=/opt && \
cd $BUILDDIR && \
\
# Install dependences
sudo apt-get update && \
sudo apt-get install -y \
build-essential \
git \
libsqlite3-dev \
software-properties-common \
sqlite3 \
sqlite3-doc && \
\
# Add brightbox ppa for the latest version of ruby
sudo apt-add-repository -y \
ppa:brightbox/ruby-ng && \
\
# Install ruby (2.2 in this example)
sudo apt-get update && \
sudo apt-get install -y \
ruby2.2 \
ruby2.2-dev && \
\
# Install bundler using gem
sudo gem install bundler
https://github.com/beefproject/beef/wiki/Configuration

3.1. It is recommended not to use rvm. If you use rvm the ruby binaries are installed to locations outside of your default path which may cause problems later.

4. Prerequisites (Mac OSX)

- XCode: provides the sqlite support BeEF needs

- Ruby 2.1
To install RVM and Ruby 2.1.5 on Mac OS:
$ bash -s stable < <(curl -Ls https://raw.githubusercontent.com/wayneeseguin/rvm/master/binscripts/rvm-installer) source ~/.bash_profile
$ rvm install 2.1.5
$ rvm use 2.1.5

Start BeEF
----------

5. Install instructions

Obtain application code either by downloading an archive from https://github.com/beefproject/beef/archive/master.zip or cloning the GIT repo https://github.com/beefproject/beef.git
To start BeEF, simply run:

Enter into the newly created BeEF directory, and type:
$ ./beef

bundle install

Bundler installs all the pre-requisite gems.
Updating
--------

6. Run instructions
Due to the fast-paced nature of web browser development and webappsec landscape,
it's best to regularly update BeEF to the latest version.

Simply run:
If you're using BeEF from the GitHub repository, updating is as simple as:

./beef -x
$ git pull

Loading

0 comments on commit 633ccdd

Please sign in to comment.