bettercap 1.1.10 → 1.2.0

data/lib/bettercap/packet_queue.rb

@@ -0,0 +1,92 @@
+=begin
+BETTERCAP
+Author : Simone 'evilsocket' Margaritelli
+Email  : evilsocket@gmail.com
+Blog   : http://www.evilsocket.net/
+This project is released under the GPL 3 license.
+=end
+require 'bettercap/error'
+
+module BetterCap
+# This class is responsible for sending various network packets.
+class PacketQueue
+  # Initialize the PacketQueue, it will spawn +nworkers+ thread and
+  # will send packets to the +iface+ network interface.
+  def initialize( iface, nworkers = 4 )
+    @iface    = iface
+    @nworkers = nworkers
+    @running  = true
+    @injector = PacketFu::Inject.new(:iface => iface)
+    @queue    = Queue.new
+    @workers  = (0...nworkers).map {
+      ::Thread.new {
+        Logger.debug "PacketQueue worker started."
+
+        while @running
+          begin
+            packet = @queue.pop
+            # nil packet pushed to signal stopping
+            if packet.nil?
+              Logger.debug "Got nil packet, PacketQueue stopping ..."
+              break
+
+            # [ ip, port, data ] pushed by Discovery::Agents::Udp
+            elsif packet.is_a?(Array)
+              ip, port, data = packet
+              Logger.debug "Sending UDP data packet to #{ip}:#{port} ..."
+
+              # TODO: Maybe just create one globally?
+              sd = UDPSocket.new
+              sd.send( data, 0, ip, port )
+              sd = nil
+
+            # PacketFu packet
+            else
+              Logger.debug "Sending #{packet.class.name} packet ..."
+
+              # Use a global PacketFu::Inject object.
+              @injector.array = [packet.headers[0].to_s]
+              @injector.inject
+            end
+          rescue Exception => e
+            Logger.debug "#{self.class.name} ( #{packet.class.name} ) : #{e.message}"
+
+            # If we've got an error message such as:
+            #   (cannot open BPF device) /dev/bpf0: Too many open files
+            # We want to retry to probe this ip in a while.
+            if e.message.include? 'Too many open files'
+              Logger.debug "Repushing #{self.class.name} to the packet queue ..."
+              push(packet)
+            end
+          end
+        end
+
+        Logger.debug "PacketQueue worker stopped."
+      }
+    }
+  end
+
+  # Push a packet to the queue.
+  def push(packet)
+    @queue.push(packet)
+  end
+
+  # Wait for the packet queue to be empty.
+  def wait_empty( timeout )
+    begin
+      Timeout::timeout(timeout) {
+        while !@queue.empty?
+          sleep 0.5
+        end
+      }
+    rescue; end
+  end
+
+  # Notify the queue to stop and wait for every worker to finish.
+  def stop
+    @running = false
+    @nworkers.times { push(nil) }
+    @workers.map(&:join)
+  end
+end
+end

data/lib/bettercap/proxy/certstore.rb

@@ -14,55 +14,61 @@ require 'openssl'
 
 module BetterCap
 module Proxy
-  class CertStore
-    @@selfsigned = {}
-    @@frompems = {}
+# Class responsible of handling digital certificate loading or on the fly
+# creation.
+class CertStore
+  @@selfsigned = {}
+  @@frompems = {}
 
-    def self.from_file( filename )
-      unless @@frompems.has_key? filename
-        Logger.info "Loading self signed HTTPS certificate from '#{filename}' ..."
+  # Load a certificate from the +filename+ file and return an
+  # OpenSSL::X509::Certificate instance for it.
+  def self.from_file( filename )
+    unless @@frompems.has_key? filename
+      Logger.info "Loading self signed HTTPS certificate from '#{filename}' ..."
 
-        pem = File.read filename
+      pem = File.read filename
 
-        @@frompems[filename] = { :cert => OpenSSL::X509::Certificate.new(pem), :key => OpenSSL::PKey::RSA.new(pem) }
-      end
-
-      @@frompems[filename]
+      @@frompems[filename] = { :cert => OpenSSL::X509::Certificate.new(pem), :key => OpenSSL::PKey::RSA.new(pem) }
     end
 
-    def self.get_selfsigned( subject = '/C=US/ST=California/L=Mountain View/O=Google Inc/CN=www.google.com' )
-      unless @@selfsigned.has_key? subject
-        Logger.info "Generating self signed HTTPS certificate for subject '#{subject}' ..."
-
-        key = OpenSSL::PKey::RSA.new(2048)
-        public_key = key.public_key
-
-        cert = OpenSSL::X509::Certificate.new
-        cert.subject = cert.issuer = OpenSSL::X509::Name.parse(subject)
-        cert.not_before = Time.now
-        cert.not_after = Time.now + 365 * 24 * 60 * 60
-        cert.public_key = public_key
-        cert.serial = 0x0
-        cert.version = 2
-
-        ef = OpenSSL::X509::ExtensionFactory.new
-        ef.subject_certificate = cert
-        ef.issuer_certificate = cert
-        cert.extensions = [
-            ef.create_extension("basicConstraints","CA:TRUE", true),
-            ef.create_extension("subjectKeyIdentifier", "hash"),
-            ef.create_extension("keyUsage", "cRLSign,keyCertSign", true),
-        ]
-        cert.add_extension ef.create_extension("authorityKeyIdentifier",
-                                               "keyid:always,issuer:always")
-
-        cert.sign key, OpenSSL::Digest::SHA256.new
-
-        @@selfsigned[subject] = { :cert => cert, :key => key }
-      end
-
-      @@selfsigned[subject]
+    @@frompems[filename]
+  end
+
+  # Create a self signed digital certificate using the specified +subject+ string.
+  # Will return a OpenSSL::X509::Certificate instance.
+  def self.get_selfsigned( subject = '/C=US/ST=California/L=Mountain View/O=Google Inc/CN=www.google.com' )
+    unless @@selfsigned.has_key? subject
+      Logger.info "Generating self signed HTTPS certificate for subject '#{subject}' ..."
+
+      key = OpenSSL::PKey::RSA.new(2048)
+      public_key = key.public_key
+
+      cert = OpenSSL::X509::Certificate.new
+      cert.subject = cert.issuer = OpenSSL::X509::Name.parse(subject)
+      cert.not_before = Time.now
+      cert.not_after = Time.now + 365 * 24 * 60 * 60
+      cert.public_key = public_key
+      cert.serial = 0x0
+      cert.version = 2
+
+      ef = OpenSSL::X509::ExtensionFactory.new
+      ef.subject_certificate = cert
+      ef.issuer_certificate = cert
+      cert.extensions = [
+          ef.create_extension("basicConstraints","CA:TRUE", true),
+          ef.create_extension("subjectKeyIdentifier", "hash"),
+          ef.create_extension("keyUsage", "cRLSign,keyCertSign", true),
+      ]
+      cert.add_extension ef.create_extension("authorityKeyIdentifier",
+                                             "keyid:always,issuer:always")
+
+      cert.sign key, OpenSSL::Digest::SHA256.new
+
+      @@selfsigned[subject] = { :cert => cert, :key => key }
     end
+
+    @@selfsigned[subject]
   end
 end
 end
+end

data/lib/bettercap/proxy/module.rb

@@ -13,18 +13,20 @@ require 'bettercap/logger'
 
 module BetterCap
 module Proxy
+# Base class for transparent proxy modules.
 class Module
   @@modules = []
-
+  # Return a list of registered modules.
   def self.modules
     @@modules
   end
 
-  # we're enabled by default, yo!
+  # Return true if the module is enabled, otherwise false.
   def enabled?
     true
   end
 
+  # Register available proxy modules into the system.
   def self.register_modules
     Object.constants.each do |klass|
       const = Kernel.const_get(klass)

data/lib/bettercap/proxy/proxy.rb

@@ -18,8 +18,11 @@ require 'bettercap/network'
 
 module BetterCap
 module Proxy
-
+# Transparent proxy class.
 class Proxy
+  # Initialize the transparent proxy, making it listen on +address+:+port+ and
+  # use the specified +processor+ routine for each request.
+  # If +is_https+ is true a HTTPS proxy will be created, otherwise a HTTP one.
   def initialize( address, port, is_https, processor )
     @socket      = nil
     @address     = address
@@ -49,6 +52,7 @@ class Proxy
     end
   end
 
+  # Start this proxy instance.
   def start
     begin
       @server = @socket = TCPServer.new( @address, @port )
@@ -70,6 +74,7 @@ class Proxy
     end
   end
 
+  # Stop this proxy instance.
   def stop
     begin
       Logger.info "Stopping #{@type} proxy ..."
@@ -77,7 +82,7 @@ class Proxy
       if @socket and @running
         @running = false
         @socket.close
-        @pool.shutdown
+        @pool.shutdown false
       end
     rescue
     end

data/lib/bettercap/proxy/request.rb

@@ -12,9 +12,22 @@ This project is released under the GPL 3 license.
 
 module BetterCap
 module Proxy
+# HTTP request parser.
 class Request
-  attr_reader :lines, :verb, :url, :host, :port, :content_length
-
+  # Patched request lines.
+  attr_reader :lines
+  # HTTP verb.
+  attr_reader :verb
+  # Request URL.
+  attr_reader :url
+  # Hostname.
+  attr_reader :host
+  # Request port.
+  attr_reader :port
+  # Content length.
+  attr_reader :content_length
+
+  # Initialize this object setting #port to +default_port+.
   def initialize( default_port = 80 )
     @lines  = []
     @verb   = nil
@@ -24,6 +37,8 @@ class Request
     @content_length = 0
   end
 
+  # Read lines from the +sock+ socket and parse them.
+  # Will raise an exception if the #hostname can not be parsed.
   def read(sock)
     # read the first line
     self << sock.readline
@@ -40,6 +55,7 @@ class Request
     raise "Couldn't extract host from the request." unless @host
   end
 
+  # Parse a single request line, patch it if needed and append it to #lines.
   def <<(line)
     line = line.chomp
 
@@ -57,7 +73,6 @@ class Request
       end
 
       line = "#{@verb} #{@url} HTTP/1.1"
-
     # get the host header value
     elsif line =~ /^Host:\s*(.*)$/
       @host = $1
@@ -65,34 +80,31 @@ class Request
         @host = $1
         @port = $2.to_i
       end
-
     # parse content length, this will speed up data streaming
     elsif line =~ /^Content-Length:\s+(\d+)\s*$/i
       @content_length = $1.to_i
-
     # we don't want to have hundreds of threads running
     elsif line =~ /^Connection: keep-alive/i
       line = 'Connection: close'
-
     elsif line =~ /^Proxy-Connection: (.+)/i
       line = "Connection: #{$1}"
-
     # disable gzip, chunked, etc encodings
     elsif line =~ /^Accept-Encoding:.*/i
       line = 'Accept-Encoding: identity'
-
     end
 
-      @lines << line
-    end
+    @lines << line
+  end
 
-    def post?
-      @verb == 'POST'
-    end
+  # Return true if this is a POST request, otherwise false.
+  def post?
+    @verb == 'POST'
+  end
 
-    def to_s
-      @lines.join("\n") + "\n"
-    end
+  # Return a string representation of the HTTP request.
+  def to_s
+    @lines.join("\n") + "\n"
   end
 end
 end
+end

data/lib/bettercap/proxy/response.rb

@@ -12,11 +12,26 @@ This project is released under the GPL 3 license.
 
 module BetterCap
 module Proxy
-
+# HTTP response parser.
 class Response
-  attr_reader :content_type, :charset, :content_length, :chunked, :headers, :code, :headers_done
+  # Response content type.
+  attr_reader :content_type
+  # Response charset, default to UTF-8.
+  attr_reader :charset
+  # Response content length.
+  attr_reader :content_length
+  # True if this is a chunked encoded response, otherwise false.
+  attr_reader :chunked
+  # A list of response headers.
+  attr_reader :headers
+  # Response status code.
+  attr_reader :code
+  # True if the parser finished to parse the headers, otherwise false.
+  attr_reader :headers_done
+  # Response body.
   attr_accessor :body
 
+  # Initialize this response object state.
   def initialize
     @content_type = nil
     @charset = 'UTF-8'
@@ -28,6 +43,8 @@ class Response
     @chunked = false
   end
 
+  # Read lines from the +sock+ socket until all headers are correctly parsed
+  # and return a BetterCap::Proxy::Response instance.
   def self.from_socket(sock)
     response = Response.new
 
@@ -43,6 +60,7 @@ class Response
     response
   end
 
+  # Parse a single response +line+.
   def <<(line)
     # we already parsed the heders, collect response body
     if @headers_done
@@ -80,10 +98,13 @@ class Response
     end
   end
 
+  # Return true if the response content type is textual, otherwise false.
   def textual?
     @content_type and ( @content_type =~ /^text\/.+/ or @content_type =~ /^application\/.+/ )
   end
 
+  # Return a string representation of this response object, patching the
+  # Content-Length header if the #body was modified.
   def to_s
     if textual?
       @headers.map! do |header|

data/lib/bettercap/proxy/stream_logger.rb

@@ -12,6 +12,7 @@ This project is released under the GPL 3 license.
 require 'bettercap/logger'
 
 module BetterCap
+# Raw or http streams pretty logging.
 class StreamLogger
   @@MAX_REQ_SIZE = 50
 
@@ -22,6 +23,8 @@ class StreamLogger
     '5' => :red
   }
 
+  # Search for the +addr+ IP address inside the list of collected targets and return
+  # its compact string representation ( @see BetterCap::Target#to_s_compact ).
   def self.addr2s( addr )
     ctx = Context.get
 
@@ -33,6 +36,7 @@ class StreamLogger
     addr
   end
 
+  # Log a raw packet ( +pkt+ ) data +payload+ using the specified +label+.
   def self.log_raw( pkt, label, payload )
     nl    = if label.include?"\n" then "\n" else " " end
     label = label.strip
@@ -40,6 +44,8 @@ class StreamLogger
                "[#{label.green}]#{nl}#{payload.strip.yellow}" )
   end
 
+  # Log a HTTP ( HTTPS if +is_https+ is true ) stream performed by the +client+
+  # with the +request+ and +response+ most important informations.
   def self.log_http( is_https, client, request, response )
     request_s  = "#{is_https ? 'https' : 'http'}://#{request.host}#{request.url}"
     response_s = "( #{response.content_type} )"

data/lib/bettercap/proxy/streamer.rb

@@ -13,16 +13,25 @@ require 'bettercap/logger'
 
 module BetterCap
 module Proxy
+# Handle data streaming between clients and servers for the BetterCap::Proxy::Proxy.
 class Streamer
+  # Default buffer size for data streaming.
+  BUFSIZE = 1024 * 16
+
+  # Initialize the class with the given +processor+ routine.
   def initialize( processor )
     @processor = processor
   end
 
+  # Redirect the +client+ to a funny video.
   def rickroll( client )
     client.write "HTTP/1.1 302 Found\n"
     client.write "Location: https://www.youtube.com/watch?v=dQw4w9WgXcQ\n\n"
   end
 
+  # Perform HTML streaming for the given +request+, applying the #processor
+  # to the +response+.
+  # +from+ and +to+ are the two TCP endpoints.
   def html( request, response, from, to )
     buff = ''
 
@@ -79,12 +88,13 @@ class Streamer
     to.write response.to_s
   end
 
-
+  # Perform binary streaming using the +opts+ dictionary.
+  # If response|request object is available inside +opts+ and a content length
+  # as well use it to speed up data streaming with precise data size
+  # +from+ and +to+ are the two TCP endpoints.
   def binary( from, to, opts = {} )
     total_size = 0
 
-    # if response|request object is available and a content length as well
-    # use it to speed up data streaming with precise data size
     if not opts[:response].nil?
       to.write opts[:response].to_s
 
@@ -127,8 +137,6 @@ class Streamer
 
   private
 
-  BUFSIZE = 1024 * 16
-
   def consume_stream io, size
     read_timeout = 60.0
     dest = ''