README.rdoc in emonti-buby-1.1.3.1 vs README.rdoc in emonti-buby-1.1.4
- old
+ new
@@ -32,12 +32,11 @@
* JRuby - http://jruby.org
Burp is Java based and the extension is developed specifically around JRuby.
The C version of ruby will not work.
* 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.
- As of version 1.1.0, Buby supports both pre and post 1.2.09 Burp extensions.
+ Buby has been tested successfully with Burp 1.2.x.
== BUILD/INSTALL:
=== Gem
@@ -95,28 +94,26 @@
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
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 below to confirm everything is set up.
-
== TEST AND USAGE EXAMPLE:
-The gem includes a command-line tool called 'buby' but it doesn't do much right
-now. You can, however, use this as a minimal test to confirm whether Burp can
-be launched from ruby and that Buby and Burp are connected.
+The gem includes a command-line executable called 'buby'. You can use this to
+test your Buby set-up and try out a few features.
-Launch buby for simple testing and debugging with the 'buby' command-line tool:
-
$ buby -h
Usage: buby [options]
- -i, --interactive Start IRB
- -d, --debug Debug info
- -B, --load-burp=PATH Load Burp Jar from PATH
- -h, --help Show this help message
+ -i, --interactive Start IRB
+ -d, --debug Debug info
+ -B, --load-burp=PATH Load Burp Jar from PATH
+ -s, --state=FILE Restore burp state file on startup
+ -r, --require=LIB load a ruby lib (or jar) after Burp loads
+ -e, --extend=MOD Extend Buby with a module (loaded via -r?)
+ -h, --help Show this help message
$ buby -i -d
[:got_extender, #<Java::Default::BurpExtender:0x80 ...>]
Global $burp is set to #<Buby:0x78de07 @burp_callbacks=#<#<Class:...>
[:got_callbacks, #<#<Class:01x38ba04>:0x90 ...>]
@@ -155,10 +152,10 @@
p = Net::HTTP::Proxy("localhost", 8080).start("www.example.com")
p.get("/")
With $DEBUG = true, you should see the debugging output from Ruby as the proxy
-passes your request back to your Ruby runtime.
+passes your request back to your HTTP client/browser.
It will look something like the following in IRB:
>> p.get("/")
[:got_proxy_request,