bettercap 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 851e88dcce552dfe264421c42fd1ad02c4ef0160
-  data.tar.gz: 25e6d2a981d6113e86c150f833405c417594d613
+  metadata.gz: f3a44959da9a916d0c0c67da9eaf293547006ba4
+  data.tar.gz: 78e4dcf3c3da73095e0a291038de9f38928875bc
 SHA512:
-  metadata.gz: 1d58eeb378e71ed4ef0059f5380763a4559d3c7f17d80da9ef54c415b760cfe47e38f52a9ea2cd2ba282ff326e87441c0b863790fa5b5b5b07ac0dd282246f3d
-  data.tar.gz: d19bc791b7cedf8f64527a981f248dd9c5b35ce1c8937df7cf1878f97c1ca0c79722c91f7c914968e288a34c798c22b385d070daa9bea686861844a1904d4ab9
+  metadata.gz: 4f8fffb6c4c2c47d6e5fee83434a7f969f9201486a77a007d2f2a0d4486e5ade866421bbed71aa9373150ddb340b0b77567b462ac68987192d98f2b72bac2052
+  data.tar.gz: c312331cded4f9e729f0255860f66e6a1402ba29cfc4613dc8a2edca42e8bc263d1430e2aae3e4c99b69b5e1520abc02204b93b285232ec4177035c3e13a7408

data/TODO.md

@@ -5,6 +5,8 @@ This is a list of TODOs I use to keep track of tasks and upcoming features.
 - [x] Implement `--ignore ADDR,ADDR,ADDR` option to filter out specific addresses from the targets list.
 - [x] HTTP 1.1 chunked response support.
 - [x] Ip address to hostname resolution.
+- [ ] Wrap every class with `module BetterCap` and refactor old code.
+- [ ] Use StreamLogger for both Proxy and Sniffer traffic. 
 - [ ] Implement event-driven core plugin infrastructure ( for webui, etc ).
 - [ ] Implement web-ui core plugin.
 - [ ] Rewrite proxy class using [em-proxy](https://github.com/igrigorik/em-proxy) library.

data/bin/bettercap

@@ -18,220 +18,51 @@ begin
   puts BetterCap::BANNER.green.bold
   puts "\n\n\n"
 
-  ctx = Context.get
-
-  OptionParser.new do |opts|
-    opts.banner = "Usage: #{$0} [options]"
-    opts.version = BetterCap::VERSION
-
-		opts.on( '-G', '--gateway ADDRESS', 'Manually specify the gateway address, if not specified the current gateway will be retrieved and used. ' ) do |v|
-      ctx.options.gateway = v
-    end
-
-    opts.on( '-I', '--interface IFACE', 'Network interface name - default: ' + ctx.options.iface.to_s ) do |v|
-      ctx.options.iface = v
-    end
-
-    opts.on( '-S', '--spoofer NAME', 'Spoofer module to use, available: ' + SpooferFactory.available.join(', ') + ' - default: ' + ctx.options.spoofer ) do |v|
-      ctx.options.spoofer = v
-    end
-
-    opts.on( '-T', '--target ADDRESS1,ADDRESS2', 'Target IP addresses, if not specified the whole subnet will be targeted.' ) do |v|
-      ctx.options.target = v
-    end
-
-    opts.on( '--ignore ADDRESS1,ADDRESS2', 'Ignore these addresses if found while searching for targets.' ) do |v|
-      ctx.options.ignore = v
-    end
-
-    opts.on( '-O', '--log LOG_FILE', 'Log all messages into a file, if not specified the log messages will be only print into the shell.' ) do |v|
-      ctx.options.logfile = v
-    end
-
-    opts.on( '-D', '--debug', 'Enable debug logging.' ) do
-      ctx.options.debug = true
-    end
-
-    opts.on( '-L', '--local', 'Parse packets coming from/to the address of this computer ( NOTE: Will set -X to true ), default to false.' ) do
-      ctx.options.local = true
-      ctx.options.sniffer = true
-    end
-
-    opts.on( '-X', '--sniffer', 'Enable sniffer.' ) do
-      ctx.options.sniffer = true
-    end
-
-    opts.on( '--sniffer-source FILE', 'Load packets from the specified PCAP file instead of the interface ( will enable sniffer ).' ) do |v|
-      ctx.options.sniffer = true
-      ctx.options.sniffer_src = File.expand_path v
-    end
-
-    opts.on( '--sniffer-pcap FILE', 'Save all packets to the specified PCAP file ( will enable sniffer ).' ) do |v|
-      ctx.options.sniffer = true
-      ctx.options.sniffer_pcap = File.expand_path v
-    end
-
-    opts.on( '--sniffer-filter EXPRESSION', 'Configure the sniffer to use this BPF filter ( will enable sniffer ).' ) do |v|
-      ctx.options.sniffer = true
-      ctx.options.sniffer_filter = v
-    end
-
-    opts.on( '-P', '--parsers PARSERS', 'Comma separated list of packet parsers to enable, "*" for all ( NOTE: Will set -X to true ), available: ' + ParserFactory.available.join(', ') + ' - default: *' ) do |v|
-      ctx.options.sniffer = true
-      ctx.options.parsers = ParserFactory.from_cmdline(v)
-    end
-
-    opts.on( '--no-discovery', 'Do not actively search for hosts, just use the current ARP cache, default to false.' ) do
-      ctx.options.arpcache = true
-    end
-
-    opts.on( '--no-spoofing', 'Disable spoofing, alias for --spoofer NONE.' ) do
-      ctx.options.spoofer = 'NONE'
-    end
-
-    opts.on( '--half-duplex', 'Enable half-duplex MITM, this will make bettercap work in those cases when the router is not vulnerable.' ) do
-      ctx.options.half_duplex = true
-    end
-
-    opts.on( '--proxy', 'Enable HTTP proxy and redirects all HTTP requests to it, default to false.' ) do
-      ctx.options.proxy = true
-    end
-
-    opts.on( '--proxy-https', 'Enable HTTPS proxy and redirects all HTTPS requests to it, default to false.' ) do
-      ctx.options.proxy = true
-      ctx.options.proxy_https = true
-    end
-
-    opts.on( '--proxy-port PORT', 'Set HTTP proxy port, default to ' + ctx.options.proxy_port.to_s + ' .' ) do |v|
-      ctx.options.proxy = true
-      ctx.options.proxy_port = v.to_i
-    end
-
-    opts.on( '--proxy-https-port PORT', 'Set HTTPS proxy port, default to ' + ctx.options.proxy_https_port.to_s + ' .' ) do |v|
-      ctx.options.proxy = true
-      ctx.options.proxy_https = true
-      ctx.options.proxy_https_port = v.to_i
-    end
-
-    opts.on( '--proxy-pem FILE', 'Use a custom PEM certificate file for the HTTPS proxy.' ) do |v|
-      ctx.options.proxy = true
-      ctx.options.proxy_https = true
-      ctx.options.proxy_pem_file = File.expand_path v
-    end
-
-    opts.on( '--proxy-module MODULE', 'Ruby proxy module to load.' ) do |v|
-      ctx.options.proxy = true
-      ctx.options.proxy_module = File.expand_path v
-    end
-
-    opts.on( '--custom-proxy ADDRESS', 'Use a custom HTTP upstream proxy instead of the builtin one.' ) do |v|
-      ctx.options.custom_proxy = v
-    end
-
-    opts.on( '--custom-proxy-port PORT', 'Specify a port for the custom HTTP upstream proxy, default to ' + ctx.options.custom_proxy_port.to_s + ' .' ) do |v|
-      ctx.options.custom_proxy_port = v.to_i
-    end
-
-    opts.on( '--custom-https-proxy ADDRESS', 'Use a custom HTTPS upstream proxy instead of the builtin one.' ) do |v|
-      ctx.options.custom_https_proxy = v
-    end
-
-    opts.on( '--custom-https-proxy-port PORT', 'Specify a port for the custom HTTPS upstream proxy, default to ' + ctx.options.custom_https_proxy_port.to_s + ' .' ) do |v|
-      ctx.options.custom_https_proxy_port = v.to_i
-    end
-
-    opts.on( '--httpd', 'Enable HTTP server, default to false.' ) do
-      ctx.options.httpd = true
-    end
-
-    opts.on( '--httpd-port PORT', 'Set HTTP server port, default to ' + ctx.options.httpd_port.to_s +  '.' ) do |v|
-      ctx.options.httpd = true
-      ctx.options.httpd_port = v.to_i
-    end
-
-    opts.on( '--httpd-path PATH', 'Set HTTP server path, default to ' + ctx.options.httpd_path +  '.' ) do |v|
-      ctx.options.httpd = true
-      ctx.options.httpd_path = v
-    end
-
-    opts.on( '--check-updates', 'Will check if any update is available and then exit.' ) do
-      ctx.options.check_updates = true
-    end
-
-    opts.on('-h', '--help', 'Display the available options.') do
-      puts opts
-      puts "\nFor examples & docs please visit " + "http://bettercap.org/docs/".bold
-      exit
-    end
-  end.parse!
-
-  if ctx.options.check_updates
-    error_policy = lambda { |e|
-      Logger.error("Could not check for udpates: #{e.message}")
-    }
-
-    ctx.check_updates(error_policy)
-    exit
-  end
-
-  raise BetterCap::Error, 'This software must run as root.' unless Process.uid == 0
-  raise BetterCap::Error, 'No default interface found, please specify one with the -I argument.' unless !ctx.options.iface.nil?
-
-  Logger.debug_enabled = true unless !ctx.options.debug
-
-  Logger.logfile = ctx.options.logfile
-
-
-  unless ctx.options.gateway.nil?
-    raise BetterCap::Error, "Invalid gateway" if !Network.is_ip?(ctx.options.gateway)
-    ctx.gateway = ctx.options.gateway
-    Logger.info("Targetting manual gateway #{ctx.gateway}")
-  end
-
-  ctx.update_network
+  # Create global context, parse command line arguments and perform basic
+  # error checking.
+  ctx = Options.parse!
 
+  # Start targets auto discovery if needed.
   if ctx.options.target.nil?
-    Logger.info( "Targeting the whole subnet #{ctx.network.to_range} ..." ) unless ctx.options.has_spoofer?
-
-    ctx.start_discovery_thread
-  else
-    ctx.targets = ctx.options.to_targets
+    Logger.info( "Targeting the whole subnet #{ctx.ifconfig[:ip4_obj].to_range} ..." ) unless ctx.options.has_spoofer?
+    ctx.discovery.start
   end
 
-  ctx.spoofer = ctx.options.to_spoofers
+  # Start network spoofers if any.
   ctx.spoofer.each do |spoofer|
     spoofer.start
   end
 
+  # Start proxies and setup port redirection.
   if ctx.options.proxy
     if ctx.options.has_http_sniffer_enabled?
       Logger.warn "WARNING: Both HTTP transparent proxy and URL parser are enabled, you're gonna see duplicated logs."
     end
-
     ctx.create_proxies
   end
 
-  ctx.enable_port_redirection
+  ctx.enable_port_redirection!
 
+  # Start local HTTP server.
   if ctx.options.httpd
     ctx.httpd = HTTPD::Server.new( ctx.options.httpd_port, ctx.options.httpd_path )
     ctx.httpd.start
   end
 
+  # Start network sniffer.
   if ctx.options.sniffer
     Sniffer.start ctx
   else
-    unless ctx.options.has_spoofer?
-      Logger.warn 'WARNING: Sniffer module was NOT enabled ( -X argument ), this will cause the MITM to run but no data to be collected.'
-    end
+    Logger.warn 'WARNING: Sniffer module was NOT enabled ( -X argument ), this '\
+                'will cause the MITM to run but no data to be collected.' unless ctx.options.has_spoofer?
+  end
 
-    loop do
-      sleep 1
-    end
+  loop do
+    sleep 10
   end
 
 rescue SystemExit, Interrupt
-  Logger.write "\n"
+  Logger.raw "\n"
 
 rescue BetterCap::Error => e
   Logger.error e.message

data/lib/bettercap.rb

@@ -24,8 +24,10 @@ require 'ipaddr'
 Object.send :remove_const, :Config rescue nil
 Config = RbConfig
 
+require 'bettercap/update_checker'
 require 'bettercap/error'
 require 'bettercap/options'
+require 'bettercap/discovery'
 require 'bettercap/context'
 require 'bettercap/monkey/packetfu/utils'
 require 'bettercap/factories/firewall_factory'

data/lib/bettercap/base/ifirewall.rb

@@ -22,11 +22,11 @@ class IFirewall
     not_implemented_method!
   end
 
-  def add_port_redirection( iface, proto, from, addr, to )
+  def add_port_redirection( r )
     not_implemented_method!
   end
 
-  def del_port_redirection( iface, proto, from, addr, to )
+  def del_port_redirection( r )
     not_implemented_method!
   end
 

data/lib/bettercap/context.rb

@@ -11,15 +11,12 @@ This project is released under the GPL 3 license.
 =end
 
 # this class holds global states & data
-require 'bettercap/version'
 require 'bettercap/error'
-require 'net/http'
-require 'json'
 
 class Context
-  attr_accessor :options, :ifconfig, :network, :firewall, :gateway,
-                :targets, :spoofer, :httpd,
-                :certificate
+  attr_accessor :options, :ifconfig, :firewall, :gateway,
+                :targets, :discovery, :spoofer, :httpd,
+                :certificate, :running
 
   @@instance = nil
 
@@ -35,135 +32,53 @@ class Context
       Logger.debug e.message
     end
 
-    @options           = Options.new iface
-    @ifconfig          = nil
-    @network           = nil
-    @firewall          = nil
-    @gateway           = nil
-    @targets           = []
-    @proxy_processor   = nil
-    @spoofer           = nil
-    @httpd             = nil
-    @certificate       = nil
-    @proxies           = []
-    @redirections      = []
-    @discovery_running = false
-    @discovery_thread  = nil
+    @running         = true
+    @options         = Options.new iface
+    @ifconfig        = nil
+    @firewall        = nil
+    @gateway         = nil
+    @targets         = []
+    @proxy_processor = nil
+    @spoofer         = nil
+    @httpd           = nil
+    @certificate     = nil
+    @proxies         = []
+    @redirections    = []
+    @discovery       = Discovery.new self
+    @firewall        = FirewallFactory.get_firewall
   end
 
-  def check_updates(error_policy = ->{ raise })
-    ver = get_latest_version
-
-    case ver
-    when BetterCap::VERSION
-      Logger.info 'You are running the latest version.'
-    else
-      Logger.warn "New version '#{ver}' available!"
-    end
-  rescue Exception => e
-    error_policy.call(e)
-  end
-
-  def get_latest_version
-    Logger.info 'Checking for updates ...'
-
-    api = URI('https://rubygems.org/api/v1/versions/bettercap/latest.json')
-    response = Net::HTTP.get_response(api)
-
-    case response
-    when Net::HTTPSuccess
-      json = JSON.parse(response.body)
-    else
-      raise response.message
-    end
-
-    return json['version']
-  end
-
-  def update_network
-    @firewall = FirewallFactory.get_firewall
+  def update!
     @ifconfig = PacketFu::Utils.ifconfig @options.iface
-    @network  = @ifconfig[:ip4_obj]
     @gateway  = Network.get_gateway if @gateway.nil?
 
-    raise BetterCap::Error, "Could not determine IPv4 address of '#{@options.iface}' interface." unless !@network.nil?
+    raise BetterCap::Error, "Could not determine IPv4 address of '#{@options.iface}', make sure this interface "\
+                            'is active and connected.' if @ifconfig[:ip4_obj].nil?
+
+    raise BetterCap::Error, "Could not detect the gateway address for interface #{@options.iface}, "\
+                            'make sure you\'ve specified the correct network interface to use and to have the '\
+                            'correct network configuration, this could also happen if bettercap '\
+                            'is launched from a virtual environment.' if @gateway.nil? or !Network.is_ip?(@gateway)
 
-    Logger.debug "network=#{@network} gateway=#{@gateway} local_ip=#{@ifconfig[:ip_saddr]}"
+    Logger.debug "network=#{@ifconfig[:ip4_obj]} gateway=#{@gateway} local_ip=#{@ifconfig[:ip_saddr]}"
     Logger.debug "IFCONFIG: #{@ifconfig.inspect}"
   end
 
   def find_target ip, mac
     @targets.each do |target|
-      if target.ip == ip && ( mac.nil? || target.mac == mac )
+      if target.equals?(ip,mac)
         return target
       end
     end
     nil
   end
 
-  def start_discovery_thread
-    @discovery_running = true
-    @discovery_thread = Thread.new {
-      Logger.info( 'Network discovery thread started.' ) unless @options.arpcache
-
-      while @discovery_running
-        empty_list = false
-
-        if @targets.empty? and @options.should_discover_hosts?
-          empty_list = true
-          Logger.info 'Searching for alive targets ...'
-        else
-          # make sure we don't stress the logging system
-          10.times do
-            sleep 1
-            if !@discovery_running
-              break
-            end
-          end
-        end
-
-        @targets = Network.get_alive_targets self
-
-        if empty_list and @options.should_discover_hosts?
-          Logger.info "Collected #{@targets.size} total targets."
-          @targets.each do |target|
-            Logger.info "  #{target}"
-          end
-        end
-      end
-    }
-  end
-
-  def stop_discovery_thread
-    @discovery_running = false
-
-    if @discovery_thread != nil
-      Logger.info( 'Stopping network discovery thread ...' ) unless @options.arpcache
-
-      begin
-        @discovery_thread.exit
-      rescue
-      end
-    end
-  end
-
-  def enable_port_redirection
+  def enable_port_redirection!
     @redirections = @options.to_redirections @ifconfig
     @redirections.each do |r|
       Logger.warn "Redirecting #{r.protocol} traffic from port #{r.src_port} to #{r.dst_address}:#{r.dst_port}"
-
-      @firewall.add_port_redirection( r.interface, r.protocol, r.src_port, r.dst_address, r.dst_port )
-    end
-  end
-
-  def disable_port_redirection
-    @redirections.each do |r|
-      Logger.debug "Removing #{r.protocol} port redirect from port #{r.src_port} to #{r.dst_address}:#{r.dst_port}"
-
-      @firewall.del_port_redirection( r.interface, r.protocol, r.src_port, r.dst_address, r.dst_port )
+      @firewall.add_port_redirection( r )
     end
-
-    @redirections = []
   end
 
   def create_proxies
@@ -220,26 +135,31 @@ class Context
   end
 
   def finalize
-    stop_discovery_thread
+    @running = false
 
-    if !@spoofer.nil? and @spoofer.length != 0
-      @spoofer.each do |itr|
-        itr.stop
-      end
+    Logger.info 'Shutting down, hang on ...'
+
+    Logger.debug 'Stopping target discovery manager ...'
+    @discovery.stop
+
+    Logger.debug 'Stopping spoofers ...'
+    @spoofer.each do |spoofer|
+      spoofer.stop
     end
 
+    Logger.debug 'Stopping proxies ...'
     @proxies.each do |proxy|
       proxy.stop
     end
 
-    disable_port_redirection
-
-    if !@firewall.nil?
-      @firewall.restore
+    Logger.debug 'Disabling port redirections ...'
+    @redirections.each do |r|
+      @firewall.del_port_redirection( r )
     end
 
-    if !@httpd.nil?
-      @httpd.stop
-    end
+    Logger.debug 'Restoring firewall state ...'
+    @firewall.restore
+
+    @httpd.stop unless @httpd.nil?
   end
 end