beef/install

#!/bin/bash
#
# Copyright (c) 2006-2021 Wade Alcorn - wade@bindshell.net
# Browser Exploitation Framework (BeEF) - http://beefproject.com
# See the file 'doc/COPYING' for copying permission
#

set -euo pipefail
IFS=$'\n\t'


info()  { echo -e "\\033[1;36m[INFO]\\033[0m  $*"; }
warn()  { echo -e "\\033[1;33m[WARNING]\\033[0m  $*"; }
fatal() { echo -e "\\033[1;31m[FATAL]\\033[0m  $*"; exit 1 ; }

RUBYSUFFIX=''

command_exists () {

  command -v "${1}" >/dev/null 2>&1
}


get_permission () {

  warn 'This script will install BeEF and its required dependencies (including operating system packages).'

  read -rp  "Are you sure you wish to continue (Y/n)? " 
  if [ "$(echo "${REPLY}" | tr "[:upper:]" "[:lower:]")" = "n" ] ; then
    fatal 'Installation aborted'
  fi
  

}


check_os () {

  info "Detecting OS..."

  OS=$(uname)
  readonly OS
  info "Operating System: $OS"
  if [ "${OS}" = "Linux" ] ; then
    info "Launching Linux install..."
    install_linux
  elif [ "${OS}" = "Darwin" ]; then
    info "Launching Mac OSX install..."
    install_mac
  elif [ "${OS}" = "FreeBSD" ]; then
    info "Launching FreeBSD install..."
    for SUFX in 26 25 24 23
    do
      if command_exists ruby${SUFX}
      then
        RUBYSUFFIX=${SUFX}
        break
      fi
    done
    install_freebsd
  elif [ "${OS}" = "OpenBSD" ]; then
    info "Launching OpenBSD install..."
    for SUFX in 26 25 24 23
    do
      if command_exists ruby${SUFX}
      then
        RUBYSUFFIX=${SUFX}
        break
      fi
    done
    install_openbsd
  else
    fatal "Unable to locate installer for your Operating system: $OS"
  fi
}


install_linux () {

  info "Detecting Linux OS distribution..."

  Distro=''
  if [ -f /etc/blackPanther-release ] ; then
    Distro='blackPanther'
  elif [ -f /etc/redhat-release ] ; then
    Distro='RedHat'
  elif [ -f /etc/debian_version ] ; then
    Distro='Debian'
  elif [ -f /etc/alpine-release ] ; then
    Distro='Alpine'
  elif [ -f /etc/os-release ] ; then
    #DISTRO_ID=$(grep ^ID= /etc/os-release | cut -d= -f2-)
    DISTRO_ID=$(cat /etc/os-release | grep  ID= | grep -v "BUILD" | grep -v "IMAGE" | cut -d= -f2-)
    if [ "${DISTRO_ID}" = 'kali' ] ; then
      Distro='Kali'
    elif [ "${DISTRO_ID}" = 'arch' ] || [ "${DISTRO_ID}" = 'manjaro' ] ; then
      Distro='Arch'
    fi
  fi

  if [ -z "${Distro}" ] ; then
    fatal "Unable to locate installer for your ${OS} distribution"
  fi
  readonly Distro
  info "OS Distribution: ${Distro}"
  info "Installing ${Distro} prerequisite packages..."
  if [ "${Distro}" = "Debian" ] || [ "${Distro}" = "Kali" ]; then
    sudo apt-get update
    sudo apt-get install curl git build-essential openssl libreadline6-dev zlib1g zlib1g-dev libssl-dev libyaml-dev libsqlite3-0 libsqlite3-dev sqlite3 libxml2-dev libxslt1-dev autoconf libc6-dev libncurses5-dev automake libtool bison nodejs libcurl4-openssl-dev
    if command_exists rvm || command_exists rbenv version; then
      info "Ruby package Manager exists - Ruby install skipped"
    else
      info "No Ruby package manager detected - will install Ruby"
      sudo apt-get install ruby-dev
    fi
  elif [ "${Distro}" = "RedHat" ]; then
    sudo yum install -y git make gcc openssl-devel gcc-c++ patch readline readline-devel zlib zlib-devel libyaml-devel libffi-devel bzip2 autoconf automake libtool bison sqlite-devel nodejs
  elif [ "${Distro}" = "blackPanther" ]; then
    installing --auto git make gcc openssl-devel gcc-c++ patch readline-devel zlib-devel yaml-devel libffi-devel bzip2 autoconf automake libtool bison sqlite-devel nodejs sudo
  elif [ "${Distro}" = "Arch" ]; then
    sudo pacman -Syu # Updates repo, dependencies, etc.
    sudo pacman -S curl git make openssl gcc readline zlib libyaml sqlite bzip2 autoconf automake libtool bison nodejs # Installs dependencies
    if command_exists rvm || command_exists rbenv version; then
      info "Ruby package Manager exists - Ruby install skipped"
    else
      info "No Ruby package manager detected - will install Ruby"
      sudo pacman -S ruby ruby-rdoc
    fi
  elif [ "${Distro}" = "Alpine" ]; then
    apk update # Updates repo, dependencies, etc.
    apk add curl git build-base openssl readline-dev zlib zlib-dev libressl-dev yaml-dev sqlite-dev sqlite libxml2-dev libxslt-dev autoconf libc6-compat ncurses5 automake libtool bison nodejs  # Installs dependencies
  fi
}

install_openbsd () {

  sudo pkg_add curl git libyaml libxml libxslt bison node ruby${RUBYSUFFIX}-bundler lame espeak
}

install_freebsd () {

  sudo pkg install curl git libyaml libxslt devel/ruby-gems bison node espeak
}

install_mac () {

  local mac_deps=(curl git nodejs python3 \
  openssl readline libyaml sqlite3 libxml2 \
  autoconf ncurses automake libtool \
  bison wget)

  if ! command_exists brew; then
    fatal "Homebrew (https://brew.sh/) required to install dependencies"
  fi
  
  info "Installing dependencies via brew"

  brew update 

  for package in "${mac_deps[@]}"; do

    if brew install "${package}"; then
      info "${package} installed"
    else
      fatal "Failed to install ${package}"
    fi
    
  done
}


check_ruby_version () {

  info 'Detecting Ruby environment...'

  MIN_RUBY_VER='2.5'
  if command_exists rvm
  then
    RUBY_VERSION=$(rvm current | cut -d'-' -f 2)
    info "Ruby version ${RUBY_VERSION} is installed"
    if RUBY_VERSION -le MIN_RUBY_VER
    then 
      fatal "Ruby version ${RUBY_VERSION} is not supported. Please install Ruby ${MIN_RUBY_VER} (or newer) and restart the installer."
    fi
  elif command_exists rbenv version
  then
    RUBY_VERSION=$(rbenv version | cut -d' ' -f 2)
    info "Ruby version ${RUBY_VERSION} is installed"
    if RUBY_VERSION -le MIN_RUBY_VER
    then 
      fatal "Ruby version ${RUBY_VERSION} is not supported. Please install Ruby ${MIN_RUBY_VER} (or newer) and restart the installer."
    fi
  elif command_exists ruby${RUBYSUFFIX}
  then
    RUBY_VERSION=$(ruby${RUBYSUFFIX} -e "puts RUBY_VERSION")
    info "Ruby version ${RUBY_VERSION} is installed"
    if [ "$(ruby${RUBYSUFFIX} -e "puts RUBY_VERSION.to_f >= ${MIN_RUBY_VER}")" = 'false' ]
    then
      fatal "Ruby version ${RUBY_VERSION} is not supported. Please install Ruby ${MIN_RUBY_VER} (or newer) and restart the installer."
    fi
  else
    fatal "Ruby is not installed. Please install Ruby ${MIN_RUBY_VER} (or newer) and restart the installer."
  fi
}

check_rubygems () {
  if command_exists gem${RUBYSUFFIX}
  then
    info 'Updating rubygems...'
    sudo gem${RUBYSUFFIX} update --system
  fi
}

check_bundler () {

  info 'Detecting bundler gem...'
  
  if command_exists bundler${RUBYSUFFIX}
  then
    info "bundler${RUBYSUFFIX} gem is installed"
  else
    info 'Installing bundler gem...'
    sudo gem${RUBYSUFFIX} install bundler
  fi
}


install_beef () { 

  echo "Installing required Ruby gems..."

  if [ -w Gemfile.lock ]
  then
    /bin/rm Gemfile.lock
  fi

  if command_exists bundler${RUBYSUFFIX}
  then
    bundle${RUBYSUFFIX} install
  else
    bundle install
  fi
}

finish () {
  echo
  echo "#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#"
  echo
  info "Install completed successfully!"
  info "Run './beef' to launch BeEF"
  echo
  echo "Next steps:"
  echo
  echo "* Change the default password in config.yaml"
  echo "* Run ./update-geoipdb to install the Maxmind GeoIP database"
  echo "* Review the wiki for important configuration information:"
  echo "  https://github.com/beefproject/beef/wiki/Configuration"
  echo
  echo "#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#"
  echo
}


main () {

  clear

  if [ -f core/main/console/beef.ascii ] ; then
    cat core/main/console/beef.ascii
    echo
  fi

  echo "#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#"
  echo "                   -- [ BeEF Installer ] --                      "
  echo "#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#"
  echo

  if [ ! -z ${GITACTIONS:-} ];
  then
    info "Skipping: Running on Github Actions"
  else
    get_permission
  fi
  check_os
  check_ruby_version
  check_rubygems
  check_bundler
  install_beef
  finish
}

main "$@"