emonti-buby 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,8 @@
+== 1.0.1 / 2009-05-10
+* Enhancements
+  * Added some sugar to make swapping Burp event handlers easier.
+  * Fixed documentation errors
+
 == 1.0.0 / 2009-05-08
 
 * 1 major enhancement

data/README.rdoc

@@ -29,12 +29,16 @@ The java BurpExtender included with Buby is an implementation of IBurpExtender w
 
 == REQUIREMENTS:
 
-Buby requires a copy of Burp Suite. Not sure if this will work with the unlicensed trial version. Point is, you'll need to get this separately since it's a trade-marked commercial product of PortSwigger Ltd.
+* JRuby - http://jruby.org
+  Burp is Java based and the extension is developed specifically around JRuby.
+  The C version of ruby will not work.
 
-See http://portswigger.net/
+* Burp (pro or free version): Buby is useless without a copy of Burp. 
+  Buby has been tested successfully with both Burp Suite free and pro versions 
+  1.2, 1.2.01, and 1.2.05. See http://portswigger.net/
 
 
-== BUILD/INSTALLATION:
+== BUILD/INSTALL:
 
 === Gem
 You should be able to get up and running with just the gem and a copy of Burp. 
@@ -43,53 +47,62 @@ minus ofcourse, Burp itself.
 
   gem install emonti-buby
 
-See manual step #5 below. For best results, you'll still want to make your 
-burp.jar available in the ruby runtime library path.
+* IMPORTANT: The buby gem doesn't include a copy of Burp!  See manual step #5 
+below. For best results, you'll still want to make your burp.jar available 
+in the ruby runtime library path.
 
 
 === Manual
 Here are manual instructions if you want or need to build things yourself:
 
-1. Download buby from github
+Step 1. Download buby from github
   git clone git://github.com/emonti/buby.git
 
-2. Compile BurpExtender.java. Include jruby.jar in the classpath:
+Step 2. Compile BurpExtender.java. Include jruby.jar in the classpath:
 
   cd buby/java/src
   javac -classpath (.../jruby/root)/lib/jruby.jar:. BurpExtender.java
 
-3. Create a new lib/buby.jar
+Step 3. Create a new lib/buby.jar
 
-  jar cvf ../../lib/buby.jar .
+  jar cvf ../buby.jar .
 
-4. Copy the buby library to your JRuby library path. Your location may vary:
+Note: At this point you can also just do a rake gem:install from the 
+top-level, which will install a local 'buby' gem instead of 'emonti-buby'. If
+you do this, just skip the next step and move onto step #5.
 
-  cp buby.jar buby.rb (.../jruby)/lib/site_ruby/1.8/
+Step 4. Copy buby.rb and jar to your JRuby lib-path. Locations may vary:
 
-5. The last part is a bit tricky. Burp Suite itself is obviously not packaged
-   with buby. You'll need to somehow put your 'burp.jar' in a place where
-   it is visible in the JRuby RUBY-LIB paths. While there are a few other
-   methods added for pulling in 'burp.jar' during run-time, this one is by far
-   the least amount of hassle in the long run.
+  cd ../../
+  cp lib/buby.rb (.../jruby)/lib/site_ruby/1.8/
+  cp -p java/buby.jar (.../jruby)/lib/site_ruby/1.8/java/buby.jar
 
-Here's a quick way to see jruby's runtime lib-path:
+Step 5. 
+
+The last part is a bit tricky. Burp Suite itself is obviously not included
+with buby. You'll want to somehow put your 'burp.jar' in a place where it 
+is visible in the JRuby RUBY-LIB paths. There are a few other ways of pulling 
+in Burp during runtime, but this method probably involves the least amount of 
+hassle in the long run.
+
+JRuby gives you a 'java' site_ruby directory for this kind of thing.  Here's a 
+quick way to see jruby's runtime lib-path:
     
   jruby -e 'puts $:'
 
 There is usually a '.../jruby/lib/1.8/java' directory reference in there, 
-though the directory may not exist in your set-up yet and you may need to 
-create it.
+though the actual directory may need to be created.
 
-Note: I keep my jruby installation under my home directory. Also, I think 
-my jruby version is out of date at the time of writing. But your configuration
-should still be relatively close to this. 
-
-Here's how I have mine set up.
+Here's how I do it. I have jruby installation under my home directory.
+Your configuration details can be substituted below. 
 
   mkdir ~/jruby-1.1.5/lib/ruby/1.8/java
   ln -s ~/tools/burp.jar ~/jruby-1.1.5/lib/ruby/1.8/java/burp.jar
 
-Once this is done, everything should be ready to go.
+Now everything should be ready to go. Try at least the first few parts of the 
+test below to confirm everything is set up. Or if you installed the gem, just 
+run 'buby' from the command-line.
+
 
 == TEST AND USAGE EXAMPLE:
 

data/buby.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{buby}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Monti - Matasano Security"]
-  s.date = %q{2009-05-08}
+  s.date = %q{2009-05-10}
   s.default_executable = %q{buby}
   s.description = %q{Buby is a mashup of JRuby with the popular commercial web security testing tool Burp Suite from PortSwigger.  Burp is driven from and tied to JRuby with a Java extension using the BurpExtender API.  This extension aims to add Ruby scriptability to Burp Suite with an interface comparable to the Burp's pure Java extension interface.}
   s.email = %q{emonti@matasano.com}

data/lib/buby.rb

@@ -54,11 +54,25 @@ include_class 'BurpExtender'
 class Buby
 
   # :stopdoc:
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:
 
+  def initialize(other=nil)
+    if other
+      raise "arg 0 must be another kind of Buby" unless other.is_a? Buby
+      @burp_extender = other.burp_extender
+      @burp_callbacks = other.burp_callbacks
+    end
+  end
+
+  # Makes this handler the active Ruby handler object for the BurpExtender
+  # Java runtime. (there can be only one!)
+  def activate!
+    BurpExtender.set_handler(self)
+  end
+
   # Returns the internal reference to the BurpExtender instance. This
   # reference gets set from Java through the evt_extender_init method.
   def burp_extender; @burp_extender; end
@@ -374,8 +388,8 @@ class Buby
 
   # Prepares the java BurpExtender implementation with a reference
   # to self as the module handler and launches burp suite.
-  def start(args=[])
-    BurpExtender.set_handler(self)
+  def start_burp(args=[])
+    activate!()
     Java::Burp::StartBurp.main(args.to_java(:string))
     return self
   end
@@ -390,7 +404,7 @@ class Buby
     h_class ||= self
     init_args ||= []
     args ||= []
-    h_class.new(*init_args).start(args)
+    h_class.new(*init_args).start_burp(args)
   end
 
   # Attempts to load burp with require and confirm it provides the required 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: emonti-buby
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Eric Monti - Matasano Security
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-08 00:00:00 -07:00
+date: 2009-05-10 00:00:00 -07:00
 default_executable: buby
 dependencies: 
 - !ruby/object:Gem::Dependency