emonti-rbkb 0.6.2.1 → 0.6.6

data/History.txt

@@ -0,0 +1,32 @@
+== 0.6.6
+* Bug-fix:
+  * Http library improperly made headers unique by name. The library has
+    been changed so that headers no longer tries to pretend to be a hash.
+
+== 0.6.5.2 
+* Enhancements
+  * d64 and b64 now support the -f option for input files as rdoc indicates
+    Thanks to Cory Scott for catching this doc error his patch.
+
+== 0.6.5.1 
+* Minor bug-fix
+  * fixed a problem with the gem, version bump is for github visibility
+
+== 0.6.5 / 2009-03-24
+
+* Enhancements
+  * Added a http protocol library (Rbkb::Http)
+  * Added TLS support to telson (-S/--start-tls in cli)
+  * Added raw dump output to telson (-d raw/hex in cli : hex is default)
+
+== 0.6.4 / 2009-03-20
+
+* Enhancements
+  * Added unit tests for all cli utilities. Most are fairly complete.
+
+== 0.6.3 / 2009-03-10
+
+* Enhancements
+  * Started using bones to help manage this mess. History.txt is born!
+  * begun adding test cases for cli utils
+  * crc32 takes an optional filename argument as first arg

data/README.rdoc

@@ -34,7 +34,7 @@ the things in 'bkb' have not yet made it to 'rbkb' (and may not).
 === Command Line Tools
 
 The tools almost all support '-h', but I'll admit this only goes so far.
-See usage.txt for usage and a bit of extra info on the various tools. 
+See cli_usage.rdoc for usage and a bit of extra info on the various tools. 
 
 When I get some spare time, I'll try and do up some examples of using all
 the tools.
@@ -69,7 +69,7 @@ Ruby BlackBag has a similar set of network tools:
 Much of rbkb is implemented as a bunch of monkeypatches to Array, String, 
 Numeric and other base classes. If this suits your fancy (some people despise
 monkeypatches, this is not their fancy) then you can 'require "rbkb"' from 
-your irb sessions and own scripts. See 'lib_fun.rdoc' for more info.
+your irb sessions and own scripts. See 'lib_usage.rdoc' for more info.
 
 
 == REQUIREMENTS:
@@ -106,18 +106,21 @@ either add them to your PATH or copy/symlink them somewhere else like
 
 === Manual installation:
 
-... or ... you can also install manually without rubygems.
+  git clone git://github.com/emonti/rbkb.git
+  cd rbkb
+  rake gem:install
+
+
+or ... you can also install manually without rubygems.
 
 You can access the rbkb project at github. You'll want git installed:
 
-  git clone git://github.com/emonti/rbkb.git
-  cd rbkb
-  cp -r wxirb/lib/* /usr/lib/ruby/1.8/site_ruby/1.8 # or another ruby libdir
+  cp -r rbkb/lib/* /usr/lib/ruby/1.8/site_ruby/1.8 # or another ruby libdir
   cp bin/* ~/bin      # or wherever else in your PATH
 
 Run this to generate docs with rdoc the same way the gem would have:
 
-  rdoc --main README.rdoc README.rdoc usage.txt lib
+  rake doc:rdoc
 
 == LICENSE:
 

data/Rakefile

@@ -0,0 +1,47 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'rbkb'
+
+task :default => 'test:run'
+
+PROJ.name = 'rbkb'
+PROJ.authors = 'Eric Monti'
+PROJ.email = 'emonti@matasano.com'
+PROJ.description = 'Rbkb is a collection of ruby-based pen-testing and reversing tools. Inspired by Matasano Blackbag.'
+PROJ.url = 'http://github.com/emonti/rbkb'
+PROJ.version = Rbkb::VERSION
+PROJ.rubyforge.name = 'rbkb'
+PROJ.readme_file = 'README.rdoc'
+
+PROJ.spec.opts << '--color'
+
+PROJ.rdoc.opts << '--line-numbers'
+
+#PROJ.rdoc.opts << '--diagram'
+PROJ.notes.tags << "X"+"XX" # muhah! so we don't note our-self
+
+# exclude rcov.rb and external libs from rcov report
+PROJ.rcov.opts += [
+  "--exclude",  "rcov.rb", 
+  "--exclude", "eventmachine",
+  "--exclude", "pcap_misc.rb",
+  "--exclude", "pcaplet.rb"
+]
+
+depend_on 'eventmachine', '>= 0.12.0'
+
+# EOF

data/bin/feed

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rbkb/cli/feed"
+
+Rbkb::Cli::Feed.run()

data/bin/plugsrv

@@ -50,13 +50,13 @@ class BlitPlug
     ##----------------------------------------
 
     def dispatch_rcv(snder, data)
-      data # XXX for now
+      data # for now
     end
 
     ##----------------------------------------
 
     def dispatch_close(snder)
-      nil # XXX for now
+      nil # for now
     end
 
     ##----------------------------------------
@@ -183,7 +183,7 @@ end
 #
 # Get option arguments
 opts = OptionParser.new do |opts|
-  opts.banner = "Usage: #{$0} [options] target:tport[@[laddr:]lport]\n",
+  opts.banner = "Usage: #{File.basename $0} [options] target:tport[@[laddr:]lport]\n",
                 "  <target:tport>  = the address of the target service\n",
                 "  <@laddr:lport> = optional address and port to listen on\n"
 

data/cli_usage.rdoc

@@ -7,13 +7,11 @@ usage information. Examples to come.
 
 Base64 encode data supplied via an argument, file, or standard input.
 
-  Usage: b64 [options] <data | blank for stdin>
+Usage: b64 [options] <data | blank for stdin>
     -h, --help                       Show this message
     -v, --version                    Show version and exit
     -f, --file FILENAME              Input from FILENAME
-
-  Output options:
-    -l, --length LEN                 Encode in lines of LEN characters
+    -l, --length LEN                 Output LEN chars per line
 
 
 === bgrep
@@ -70,7 +68,7 @@ Generates a crc32 checksum for data provided via stdin or file
 
 Base64 decode an encoded chunk supplied via argument, file, or standard input.
 
-  Usage: d64 [options] <data | blank for stdin>
+Usage: d64 [options] <data | blank for stdin>
     -h, --help                       Show this message
     -v, --version                    Show version and exit
     -f, --file FILENAME              Input from FILENAME
@@ -87,6 +85,42 @@ by Unix utilities like 'xxd' as well as 'hexdump -C'.
     -l, --length LEN                 Bytes per line in hexdump (default: 16)
 
 
+=== feed
+
+This is a plug-board message feeder from static data sources.
+The "feed" handles messages opaquely and just plays them as a server or
+client in the given sequence.
+
+Feed can do the following things with minimum fuss: 
+* Import messages from files, yaml, or pcap
+* Inject custom/modified messages with "blit"
+* Run as a server or client using UDP or TCP
+* Bootstrap protocols without a lot of work up front
+* Skip uninteresting messages and focus attention on the fun ones.
+* Replay conversations for relatively unfamiliar protocols.
+* Observe client/server behaviors using different messages at 
+  various phases of a conversation.
+
+  Usage: feed [options] host:port
+      -h, --help                       Show this message
+      -v, --version                    Show version and exit
+      -o, --output=FILE                Output to file
+      -l, --listen=(ADDR:?)PORT        Server - on port (and addr?)
+      -b, --blit=(ADDR:)?PORT          Where to listen for blit
+      -i, --[no-]initiate              Send the first message on connect
+      -e, --[no-]end                   End connection when feed is exhausted
+      -s, --[no-]step                  'Continue' prompt between messages
+      -u, --udp                        Use UDP instead of TCP
+      -r, --reconnect                  Attempt to reconnect endlessly.
+      -q, --quiet                      Suppress verbose messages/dumps
+      -S, --squelch-exhausted          Squelch 'FEED EXHAUSTED' messages
+    Sources: (can be combined)
+      -f, --from-files=GLOB            Import messages from raw files
+      -x, --from-hex=FILE              Import messages from hexdumps
+      -y, --from-yaml=FILE             Import messages from yaml
+      -p, --from-pcap=FILE[:FILTER]    Import messages from pcap
+
+
 === hexify
 
 Converts a string or raw data to hex characters. Input can be supplied via 
@@ -183,14 +217,15 @@ Telson is for doing the following things with minimum fuss:
   Usage: telson [options] host:port
     -h, --help                       Show this message
     -v, --version                    Show version and exit
-    -u, --udp                        UDP mode
-    -b, --blit=ADDR:PORT             Where to listen for blit
-    -o, --output=FILE                Output to file instead of screen
+    -o, --output=FILE                Output to file
     -q, --quiet                      Turn off verbose logging
+    -d, --dump-format=hex/raw        Output conversations in hexdump or raw
+    -b, --blit=ADDR:PORT             Where to listen for blit
+    -u, --udp                        UDP mode
+    -S, --start-tls                  Initiate TLS
     -r, --reconnect                  Attempt to reconnect endlessly.
     -s, --source=(ADDR:?)PORT        Bind on port (and addr?)
 
-
 === unhexify
 
 unhexify converts a string of hex bytes back to raw data. Input can be 

data/lib/rbkb.rb

@@ -1,6 +1,51 @@
+
 module Rbkb
-  VERSION="0.6.2"
-end
+
+  # :stopdoc:
+  VERSION = '0.6.6'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module Rbkb
+
+#Rbkb.require_all_libs_relative_to(__FILE__)
 
 require 'rbkb/extends'
 
+# EOF

data/lib/rbkb/cli.rb

@@ -5,6 +5,7 @@ require 'optparse'
 # See README.rdoc for license information
 #
 module Rbkb::Cli
+
   # Rbkb::Cli::Executable is an abstract class for creating command line
   # executables using the Ruby Black Bag framework.
   class Executable
@@ -36,8 +37,9 @@ module Rbkb::Cli
       @stderr ||= param.delete(:stderr) || STDERR
       @stdin  ||= param.delete(:stdin) || STDIN
       @opts   ||= param.delete(:opts) || {}
-      make_parser()
+      @parser_got_range=nil
       yield self if block_given?
+      make_parser()
     end
 
 
@@ -45,7 +47,7 @@ module Rbkb::Cli
     def exit(ret)
       @exit_status = ret
       if defined? Rbkb::Cli::TESTING
-        raise("Exited with return code: #{ret}") if ret != 0
+        throw(((ret==0)? :exit_zero : :exit_err), ret)
       else
         Kernel.exit(ret)
       end
@@ -81,7 +83,8 @@ module Rbkb::Cli
       end
 
       @oparse.on("-v", "--version", "Show version and exit") do
-        bail("Ruby BlackBag version #{Rbkb::VERSION}")
+        @stdout.puts("Ruby BlackBag version #{Rbkb::VERSION}")
+        self.exit(0)
       end
 
       return @oparse
@@ -104,9 +107,8 @@ module Rbkb::Cli
     # executables. The base method just slurps in an optional argv and
     # runs 'parse' if it hasn't already
     def go(argv=nil)
-      if argv 
-        @argv = argv
-      end
+      @exit_status = nil
+      @argv = argv if argv 
 
       parse
 

data/lib/rbkb/cli/b64.rb

@@ -10,6 +10,8 @@ class Rbkb::Cli::B64 < Rbkb::Cli::Executable
     arg = @oparse
     arg.banner += " <data | blank for stdin>"
 
+    add_std_file_opt(:indat)
+
     arg.on("-l", "--length LEN", Numeric, "Output LEN chars per line") do |l|
         bail("length must be > 0") unless l > 0
         @opts[:len] = l
@@ -19,12 +21,15 @@ class Rbkb::Cli::B64 < Rbkb::Cli::Executable
   def parse(*args)
     super(*args)
     parse_string_argument(:indat)
+    parse_file_argument(:indat)
     parse_catchall()
+    @opts[:indat] ||= @stdin.read
   end
 
   def go(*args)
     super(*args)
     @stdout << @opts[:indat].b64(opts[:len]).chomp + "\n"
+    self.exit(0)
   end
 end
 

data/lib/rbkb/cli/bgrep.rb

@@ -6,9 +6,11 @@ require 'rbkb/cli'
 # searches for a binary string in input. string can be provided 'hexified'
 class Rbkb::Cli::Bgrep < Rbkb::Cli::Executable
   def initialize(*args)
-    super(*args)
-    @opts[:start_off] ||= 0
-    @opts[:end_off] ||= -1
+    super(*args) do |this|
+      this.opts[:start_off] ||= 0
+      this.opts[:end_off] ||= -1
+      this.opts[:include_fname] ||= true
+    end
   end
 
   def make_parser
@@ -28,8 +30,9 @@ class Rbkb::Cli::Bgrep < Rbkb::Cli::Executable
       @opts[:align] = a
     end
 
-    arg.on("-n", "--[no-]filename", "Suppress prefixing of filenames.") do |n|
-      @opts[:suppress_fname] = n
+    arg.on("-n", "--[no-]filename", 
+           "Toggle filenames. (Default: #{@opts[:include_fname]})") do |n|
+      @opts[:include_fname] = n
     end
     return arg
   end
@@ -66,16 +69,18 @@ class Rbkb::Cli::Bgrep < Rbkb::Cli::Executable
 
     loop do 
       dat.bgrep(@find, @opts[:align]) do |hit_start, hit_end, match|
-        print "#{fname}:" if fname and not @opts[:suppress_fname]
+        @stdout.write "#{fname}:" if fname and @opts[:include_fname]
 
-        puts("#{(hit_start).to_hex.rjust(8,"0")}:"+
-             "#{(hit_end).to_hex.rjust(8,"0")}:b:"+
-             "#{match.inspect}")
+        @stdout.write(
+          "#{(hit_start).to_hex.rjust(8,"0")}:"+
+          "#{(hit_end).to_hex.rjust(8,"0")}:b:"+
+          "#{match.inspect}\n")
       end
 
       break unless fname=@argv.shift
       dat = do_file_read(fname)
     end
+    self.exit(0)
   end
 end
 

data/lib/rbkb/cli/chars.rb

@@ -12,12 +12,13 @@ class Rbkb::Cli::Chars < Rbkb::Cli::Executable
 
   def parse(*args)
     super(*args)
-    bail_args @argv.join unless @argv.size == 2
+    bail_args @argv.join(' ') unless @argv.size == 2
   end
 
   def go(*args)
     super(*args)
     @stdout << @argv[1] * @argv[0].to_i
+    self.exit(0)
   end
 end
 

data/lib/rbkb/cli/crc32.rb

@@ -12,13 +12,15 @@ class Rbkb::Cli::Crc32 < Rbkb::Cli::Executable
   end
 
   def make_parser()
-    super()
+    arg = super()
+    arg.banner += " [filename]"
     add_std_file_opt(:indat)
     add_range_opts(:first, :last)
   end
 
   def parse(*args)
     super(*args)
+    parse_file_argument(:indat)
     parse_catchall()
   end
 
@@ -26,6 +28,7 @@ class Rbkb::Cli::Crc32 < Rbkb::Cli::Executable
     super(*args)
     @opts[:indat] ||= @stdin.read()
     @stdout.puts @opts[:indat][ @opts[:first] .. @opts[:last] ].crc32.to_hex
+    self.exit(0)
   end
 end