buby 1.5.0.pre2-java → 1.5.0.pre3-java

data/lib/buby/burp_extender/console_frame.rb

@@ -0,0 +1,33 @@
+class BurpExtender
+  # @api private
+  class ConsoleFrame < Java::JavaxSwing::JFrame
+    attr_accessor :burp, :pane
+    def initialize(burp_extender, pane, opts = {}, &block)
+      @burp = burp_extender
+      @pane = pane
+
+      blck = lambda do |event|
+        if event.getID == Java::JavaAwtEvent::WindowEvent::WINDOW_CLOSING
+          @pane.tar.shutdown
+          self.dispose
+        end
+      end
+
+      super(opts[:title] || 'JRuby IRB Console (tab will autocomplete)')
+      set_size(*(opts[:size] || [700, 600]))
+      content_pane.add(@pane)
+      addWindowStateListener &blck
+      addWindowListener &blck
+
+      if block_given?
+        addWindowStateListener &block
+        addWindowListener &block
+      end
+
+      @burp.callbacks.customizeUiComponent self
+      Java::JavaAwt::EventQueue.invoke_later {
+        self.visible = true
+      }
+    end
+  end
+end

data/lib/buby/burp_extender/console_pane.rb

@@ -0,0 +1,26 @@
+class BurpExtender
+  # @api private
+  class ConsolePane < Java::JavaxSwing::JScrollPane
+    attr_accessor :text, :tar
+    def initialize
+      super
+      @text = Java::JavaxSwing::JTextPane.new
+      @text.font = find_font('Monospaced', Java::JavaAwt::Font::PLAIN, 14, 'Anonymous Pro', 'Anonymous', 'Monaco', 'Andale Mono')
+      @text.margin = Java::JavaAwt::Insets.new(8,8,8,8)
+      @text.caret_color = Java::JavaAwt::Color.new(0xa40000)
+      @text.background  = Java::JavaAwt::Color.new(0xf2f2f2)
+      @text.foreground  = Java::JavaAwt::Color.new(0xa40000)
+      self.viewport_view = @text
+      @tar = Java::OrgJrubyDemo::TextAreaReadline.new(@text, " Welcome to the Burp JRuby IRB Console [#{JRUBY_VERSION} (#{RUBY_VERSION})]\n\n")
+      JRuby.objectspace = true # useful for code completion
+      @tar.hook_into_runtime_with_streams(JRuby.runtime)
+    end
+
+    # Try to find preferred font family, use otherwise -- err --  otherwise
+    def find_font(otherwise, style, size, *families)
+      avail_families = Java::JavaAwt::GraphicsEnvironment.local_graphics_environment.available_font_family_names
+      fontname = families.find(proc {otherwise}) { |name| avail_families.include? name }
+      Java::JavaAwt::Font.new(fontname, style, size)
+    end
+  end
+end

data/lib/buby/burp_extender/console_tab.rb

@@ -0,0 +1,15 @@
+require 'buby/version'
+
+class BurpExtender
+  # @api private
+  class ConsoleTab
+    include Java::Burp::ITab
+    attr_accessor :ui_component, :tab_caption
+    CAPTION = "Buby v#{Buby::Version::STRING}"
+
+    def initialize component, caption = nil
+      @ui_component = component
+      @tab_caption = caption || CAPTION
+    end
+  end
+end

data/lib/buby/burp_extender/context_menu.rb

@@ -0,0 +1,29 @@
+require 'buby/burp_extender/context_menu_item'
+
+# @api private
+class BurpExtender
+  # @api private
+  class ContextMenu < Java::JavaxSwing::JMenu
+    attr_accessor :burp, :invocation
+    def initialize burp_extender, invocation
+      @burp = burp_extender
+      @invocation = invocation
+      super 'Buby'
+
+      if @burp.frame
+        self.add(ContextMenuItem.new('Move console to tab', @burp, @invocation) do |event|
+          burp = event.source.burp
+          invocation = event.source.invocation
+          burp.move_to_tab
+        end)
+      else
+        self.add(ContextMenuItem.new('Move console to window', @burp, @invocation) do |event|
+          burp = event.source.burp
+          invocation = event.source.invocation
+          burp.move_to_window
+        end)
+
+      end
+    end
+  end
+end

data/lib/buby/burp_extender/context_menu_factory.rb

@@ -0,0 +1,17 @@
+require 'buby/burp_extender/context_menu'
+
+class BurpExtender
+  # @api private
+  class ContextMenuFactory
+    attr_accessor :burp
+    include Java::Burp::IContextMenuFactory
+    def initialize burp_extender
+      @burp = burp_extender
+    end
+
+    def createMenuItems invocation
+      pp [:createMenuItems, invocation] if $DEBUG
+      [BurpExtender::ContextMenu.new(@burp, invocation)]
+    end
+  end
+end

data/lib/buby/burp_extender/context_menu_item.rb

@@ -0,0 +1,13 @@
+class BurpExtender
+  # @api private
+  class ContextMenuItem < Java::JavaxSwing::JMenuItem
+    attr_accessor :invocation, :burp
+    def initialize text, burp_extender, invocation, &block
+      super text
+      @invocation = invocation
+      @burp = burp_extender
+
+      addActionListener &block
+    end
+  end
+end

data/lib/buby/burp_extender/jcheck_box_menu_item.rb

@@ -0,0 +1,12 @@
+class BurpExtender
+  class JCheckBoxMenuItem < Java::JavaxSwing::JCheckBoxMenuItem
+    attr_accessor :burp
+    def initialize(burp_extender, *args, &block)
+      super *args
+      @burp = burp_extender
+      if block_given?
+        addActionListener &block
+      end
+    end
+  end
+end

data/lib/buby/burp_extender/jmenu.rb

@@ -0,0 +1,11 @@
+class BurpExtender
+  # @api private
+  class JMenu < Java::JavaxSwing::JMenu
+    attr_accessor :burp
+    def initialize burp_extender, name = nil
+      name ||= burp_extender.handler.class.name
+      @burp = burp_extender
+      super name
+    end
+  end
+end

data/lib/buby/burp_extender/jmenu_item.rb

@@ -0,0 +1,12 @@
+class BurpExtender
+  # @api private
+  class JMenuItem < Java::JavaxSwing::JMenuItem
+    attr_accessor :burp
+    def initialize text, burp_extender, &block
+      super text
+      @burp = burp_extender
+
+      addActionListener &block
+    end
+  end
+end

data/lib/buby/burp_extender/menu.rb

@@ -0,0 +1,11 @@
+class BurpExtender
+  # @api private
+  class Menu < Java::JavaAwt::Menu
+    attr_accessor :burp
+    def initialize burp_extender, name = nil
+      name ||= burp_extender.handler.class.name
+      @burp = burp_extender
+      super name
+    end
+  end
+end

data/lib/buby/burp_extender/menu_item.rb

@@ -0,0 +1,12 @@
+class BurpExtender
+  # @api private
+  class MenuItem < Java::JavaAwt::MenuItem
+    attr_accessor :burp
+    def initialize text, burp_extender, &block
+      super text
+      @burp = burp_extender
+
+      addActionListener &block
+    end
+  end
+end

data/lib/buby/extender.rb

@@ -0,0 +1,156 @@
+class Buby
+  # This is the JRuby implementation of IBurpExtender for use as a JRuby
+  # extension. This class handles the type conversions and other ruby sugar.
+  # {BurpExtender} further extends this by adding additional things during
+  # startup, like setting up Buby as the handler class and starting console
+  # tabs.
+  # 
+  # @note This class, unlike the Java implementation, does not fire the
+  #   deprecated evt_* callbacks, only the new versions.
+  #
+  # @todo move implant logic to extender interfaces
+  module Extender
+    include Java::Burp::IBurpExtender
+    include Java::Burp::IExtensionStateListener
+    include Java::Burp::IProxyListener
+    include Java::Burp::IHttpListener
+    include Java::Burp::IScannerListener
+    include Java::Burp::IScopeChangeListener
+    include Java::Burp::IContextMenuFactory
+
+    # @group Buby internals
+    # Internal reference to ruby handler class (usually {Buby})
+    @@handler = nil
+
+    # Returns the internal Ruby handler reference. 
+    #
+    # The handler is the ruby class or module used for proxying BurpExtender 
+    # events into a ruby runtime. Usually, this is Buby or a subclass.
+    #
+    def self.handler
+      @@handler
+    end
+
+    # Sets an internal reference to the ruby handler class or module to use for
+    # proxied BurpExtender events into a ruby runtime.
+    #
+    # Generally, this should probably be called in {#registerExtenderCallbacks}.
+    # However, it is also possible to set this afterwards and even swap in new
+    # objects during runtime.
+    #
+    def self.handler=(hndlr)
+      @@handler = hndlr
+    end
+
+    def handler
+      @@handler
+    end
+
+    def handler= hndlr
+      @@handler = hndlr
+    end
+
+    # @group Burp extender
+    # This callback usually fires before the handler is set.
+    #
+    def initialize *args
+      @@handler.extender_initialize(*args) if @@handler.respond_to? :extender_inititialize
+    end
+
+    # This method is invoked when the extension is loaded. It registers an
+    # instance of the +IBurpExtenderCallbacks+ interface, providing methods that
+    # may be invoked by the extension to perform various actions.
+    #
+    # @param [IBurpExtenderCallbacks] callbacks Burp's Java object for querying
+    #   Burp's data.
+    # @return [void]
+    #
+    def registerExtenderCallbacks(callbacks)
+      @callbacks = callbacks
+      callbacks.issueAlert("[#{self.class}] registering JRuby handler callbacks")
+      callbacks.registerExtensionStateListener(self)
+      callbacks.registerHttpListener(self)
+      callbacks.registerScannerListener(self)
+      callbacks.registerContextMenuFactory self
+      callbacks.registerScopeChangeListener self
+      @@handler.register_callbacks(callbacks) if @@handler.respond_to? :register_callbacks
+    end
+
+    # @group Listeners
+    # This method is called when the extension is unloaded. This, in turn, calls
+    # {Buby#extension_unloaded} on the handler instance
+    #
+    def extensionUnloaded
+      @@handler.extension_unloaded if @@handler.respond_to? :extension_unloaded
+    end
+
+    # This method is invoked when an HTTP message is being processed by the
+    # Proxy and calls {Buby#process_proxy_message} on the handler.
+    #
+    # @param [Boolean] messageIsRequest Indicates whether the HTTP message is a
+    #   request or a response.
+    # @param [IInterceptedProxyMessage] message An +IInterceptedProxyMessage+
+    #   object that extensions can use to query and update details of the
+    #   message, and control whether the message should be intercepted and
+    #   displayed to the user for manual review or modification.
+    # @return [void]
+    #
+    def processProxyMessage(messageIsRequest, message)
+      @@handler.process_proxy_message(messageIsRequest, message) if @@handler.respond_to? :process_proxy_message
+    end
+
+    # This method is invoked when an HTTP request is about to be issued, and
+    # when an HTTP response has been received.
+    #
+    # @param [Fixnum] toolFlag A flag indicating the Burp tool that issued the
+    #   request. Burp tool flags are defined in the +IBurpExtenderCallbacks+
+    #   interface.
+    # @param [Boolean] messageIsRequest Flags whether the method is being
+    #   invoked for a request or response.
+    # @param [IHttpRequestResponse] messageInfo Details of the request /
+    #   response to be processed. Extensions can call the setter methods on this
+    #   object to update the current message and so modify Burp's behavior.
+    # @return [void]
+    #
+    def processHttpMessage(toolFlag, messageIsRequest, messageInfo)
+      @@handler.process_http_message(toolFlag, messageIsRequest, messageInfo) if @@handler.respond_to? :process_http_message
+    end
+
+    # This method is invoked when a new issue is added to Burp Scanner's
+    # results.
+    #
+    # @param [IScanIssue] issue An +IScanIssue+ object that the extension can
+    #   query to obtain details about the new issue.
+    #
+    def newScanIssue(issue)
+      @@handler.new_scan_issue(issue) if @@handler.respond_to? :new_scan_issue
+    end
+
+    # This method will be called by Burp when the user invokes a context menu
+    # anywhere within Burp. The factory can then provide any custom context menu
+    # items that should be displayed in the context menu, based on the details
+    # of the menu invocation.
+    #
+    # @param [IContextMenuInvocation] invocation An object the extension can
+    #   query to obtain details of the context menu invocation.
+    # @return [Array<JMenuItem>, nil] A list of custom menu items (which may
+    #   include sub-menus, checkbox menu items, etc.) that should be displayed.
+    #   Extensions may return +nil+ from this method, to indicate that no menu
+    #   items are required.
+    #
+    # @abstract
+    def createMenuItems invocation
+      @@handler.create_menu_items(invocation) if @@handler.respond_to? :create_menu_items
+    end
+
+    # This method is invoked whenever a change occurs to Burp's suite-wide
+    # target scope.
+    #
+    # @return [void]
+    #
+    # @abstract
+    def scopeChanged
+      @@handler.scope_changed if @@handler.respond_to? :scope_changed
+    end
+  end
+end

data/lib/buby/implants/context_menu_invocation.rb

@@ -41,13 +41,41 @@ class Buby
       # Context menu is being invoked in a search results window.
       CONTEXT_SEARCH_RESULTS = 10;
 
+      # This method can be used to retrieve details of the HTTP requests /
+      # responses that were shown or selected by the user when the context menu
+      # was invoked.
+      #
+      # @note For performance reasons, the objects returned from this method are
+      #   tied to the originating context of the messages within the Burp UI.
+      #   For example, if a context menu is invoked on the Proxy intercept
+      #   panel, then the +IHttpRequestResponse+ returned by this method will
+      #   reflect the current contents of the interception panel, and this will
+      #   change when the current message has been forwarded or dropped. If your
+      #   extension needs to store details of the message for which the context
+      #   menu has been invoked, then you should query those details from the
+      #   +IHttpRequestResponse+ at the time of invocation, or you should use
+      #   +IBurpExtenderCallbacks.saveBuffersToTempFiles()+ to create a
+      #   persistent read-only copy of the +IHttpRequestResponse+.
+      #
+      # @return [Array<IHttpRequestResponse>,nil] An array of objects
+      #   representing the items that were shown or selected by the user when
+      #   the context menu was invoked. This method returns +nil+ if no messages
+      #   are applicable to the invocation.
+      #
       def getSelectedMessages
         pp [:got_get_selected_messages] if $DEBUG
         hrrl = __getSelectedMessages
         HttpRequestResponseHelper.implant(hrrl.first)
         hrrl
       end
-    
+
+      # This method can be used to retrieve details of the Scanner issues that
+      # were selected by the user when the context menu was invoked.
+      #
+      # @return [Array<IScanIssue>,nil] The issues that were selected by the
+      #   user when the context menu was invoked. This method returns +nil+ if
+      #   no Scanner issues are applicable to the invocation.
+      #
       def getSelectedIssues
         pp [:got_get_selected_issues] if $DEBUG
         sil = __getSelectedIssues
@@ -58,7 +86,6 @@ class Buby
       # Install ourselves into the current +IContextMenuInvocation+ java class
       # @param [IContextMenuInvocation] invocation
       #
-      # @todo __persistent__?
       def self.implant(invocation)
         unless invocation.implanted? || invocation.nil?
           pp [:implanting, invocation, invocation.class] if $DEBUG

data/lib/buby/implants/cookie.rb

@@ -18,7 +18,6 @@ class Buby
       # Install ourselves into the current +ICookie+ java class
       # @param [ICookie] cookie instance
       #
-      # @todo __persistent__?
       def self.implant(cookie)
         unless cookie.implanted? || cookie.nil?
           pp [:implanting, cookie, cookie.class] if $DEBUG

data/lib/buby/implants/extension_helpers.rb

@@ -245,46 +245,9 @@ class Buby
         Buby::Implants::ScannerInsertionPoint.implant(__makeScannerInsertionPoint(insertion_point_name, base_request, from, to))
       end
 
-      def self.extend_proxy(arg)
-        pp [self, arg, arg.class]
-        a_methods = %w{
-          analyzeRequest
-          analyzeResponse
-          getRequestParameter
-          indexOf
-          buildHttpMessage
-          buildHttpRequest
-          addParameter
-          removeParameter
-          updateParameter
-          toggleRequestMethod
-          buildHttpService
-          buildParameter
-          makeScannerInsertionPoint            
-        }
-        a_methods.each do |meth|
-          pp ["__" + meth, self] if $DEBUG
-          arg.class_exec(meth) do |meth|
-            alias_method "__"+meth.to_s, meth
-          end
-        end
-        a_methods.each do |meth|
-          pp [meth, self] if $DEBUG
-          arg.java_class.ruby_names_for_java_method(meth).each do |ruby_meth|
-            pp [ruby_meth, meth, self] if $DEBUG
-            arg.class_exec(ruby_meth, meth, instance_method(meth)) do |ruby_meth, meth_name, meth|
-              define_method meth_name, meth
-              # alias_method ruby_meth, "__"+meth unless ruby_meth == meth
-            end
-          end
-        end
-        include Buby::Implants::Proxy
-      end
-
       # Install ourselves into the current +IExtensionHelpers+ java class
       # @param [IExtensionHelpers] helpers
       #
-      # @todo __persistent__?
       def self.implant(helpers)
         unless helpers.implanted? || helpers.nil?
           pp [:implanting, helpers, helpers.class] if $DEBUG