ronin 0.0.9

data/lib/ronin/runner/program/program.rb

@@ -0,0 +1,173 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/runner/program/command'
+require 'ronin/runner/program/options'
+require 'ronin/runner/program/exceptions/unknown_command'
+require 'ronin/console'
+require 'ronin/version'
+
+module Ronin
+  module Runner
+    module Program
+      #
+      # Returns the commands registered with the Program.
+      #
+      def Program.commands
+        @@commands ||= []
+      end
+
+      #
+      # Returns the Hash of the Command names and their Command objects
+      # registered with the Program.
+      #
+      def Program.commands_by_name
+        @@commands_by_name ||= {}
+      end
+
+      #
+      # Returns +true+ if the a Command with the specified _name_ was
+      # registered with the Program.
+      #
+      def Program.has_command?(name)
+        Program.commands_by_name.has_key?(name.to_s)
+      end
+
+      #
+      # Returns the Command registered with the Program with the specified
+      # _name_.
+      #
+      def Program.get_command(name)
+        name = name.to_s
+
+        unless Program.has_command?(name)
+          raise(UnknownCommand,"unknown command #{name.dump}",caller)
+        end
+
+        return Program.commands_by_name[name]
+      end
+
+      #
+      # Prints the specified error _message_.
+      #
+      def Program.error(message)
+        STDERR.puts "ronin: #{message}"
+        return false
+      end
+
+      #
+      # Exits successfully from the Program. If a _block_ is given, it will
+      # be called before the Program is exited.
+      #
+      def Program.success(&block)
+        block.call(self) if block
+        exit
+      end
+
+      #
+      # Prints the given error _messages_ and exits unseccessfully from the
+      # Program. If a _block_ is given, it will be called before any
+      # error _messages_ are printed.
+      #
+      def Program.fail(*messages,&block)
+        block.call(self) if block
+
+        messages.each do |mesg|
+          Program.error(mesg)
+        end
+
+        exit -1
+      end
+
+      #
+      # If a _topic_ is given, the help message for that _topic_ will be
+      # printed, otherwise a list of available commands will be printed.
+      #
+      def Program.help(topic=nil)
+        if topic
+          begin
+            get_command(topic).help
+          rescue UnknownCommand => exp
+            Program.fail(exp)
+          end
+        else
+          puts 'Available commands:'
+
+          Program.commands.each do |cmd|
+            puts "  #{cmd.command_names.join(', ')}"
+          end
+        end
+      end
+
+      #
+      # The default command to run with the given _argv_ Array when no
+      # sub-command is given.
+      #
+      def Program.default_command(*argv)
+        Options.new('ronin','<command> [options]') { |opts|
+          opts.options do |opts|
+            opts.on('-r','--require LIB','require the specified library or path') do |lib|
+              Console.auto_load << lib.to_s
+            end
+
+            opts.on('-V','--version','print version information and exit') do
+              Program.success do
+                puts "Ronin #{Ronin::VERSION}"
+              end
+            end
+          end
+
+          opts.summary('Ronin is a Ruby development platform designed for information security','and data exploration tasks.')
+        }.parse(argv) { |opts,args|
+          Console.start
+        }
+      end
+
+      #
+      # Runs the Program with the given _argv_ Array. If the first argument
+      # is a sub-command name, the Program will attempt to find and execute
+      # the Command with the same name.
+      #
+      def Program.run(*argv)
+        begin
+          if (argv.empty? || argv[0][0..0]=='-')
+            Program.default_command(*argv)
+          else
+            cmd = argv.first
+            argv = argv[1..-1]
+
+            if Program.has_command?(cmd)
+              Program.commands_by_name[cmd].run(*argv)
+            else
+              Program.fail("unknown command #{cmd.dump}")
+            end
+          end
+        rescue OptionParser::MissingArgument, OptionParser::InvalidOption => e
+          Program.fail(e)
+        end
+
+        return true
+      end
+    end
+  end
+end

data/lib/ronin/runner/program/runner.rb

@@ -0,0 +1,35 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/runner/program/program'
+
+module Ronin
+  module Runner
+    #
+    # See Program.run.
+    #
+    def Runner.program(argv)
+      Program.run(*argv)
+    end
+  end
+end

data/lib/ronin/sessions.rb

@@ -0,0 +1,32 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/sessions/session'
+require 'ronin/sessions/tcp'
+require 'ronin/sessions/udp'
+require 'ronin/sessions/smtp'
+require 'ronin/sessions/esmtp'
+require 'ronin/sessions/pop3'
+require 'ronin/sessions/imap'
+require 'ronin/sessions/telnet'
+require 'ronin/sessions/web'

data/lib/ronin/sessions/esmtp.rb

@@ -0,0 +1,76 @@
+#
+#--
+# Ronin - A ruby development platform designed for information security
+# and data exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/sessions/session'
+require 'ronin/network/esmtp'
+
+module Ronin
+  module Sessions
+    module SMTP
+      include Session
+
+      ESMTP_SESSION = proc do
+        parameter :esmtp_host, :description => 'ESMTP host'
+        parameter :esmtp_port, :description => 'ESMTP port'
+
+        parameter :esmtp_login, :description => 'ESMTP login'
+        parameter :esmtp_user, :description => 'ESMTP user'
+        parameter :esmtp_password, :description => 'ESMTP password'
+      end
+
+      def self.included(base)
+        Session.setup_class(base,&ESMTP_SESSION)
+      end
+
+      def self.extended(obj)
+        Session.setup_object(obj,&ESMTP_SESSION)
+      end
+
+      protected
+
+      def esmtp_message(options={},&block)
+        Network::SMTP.message(options,&block)
+      end
+
+      def esmtp_connect(options={},&block)
+        unless @esmtp_host
+          raise(ParamNotFound,"Missing parameter #{describe_param(:esmtp_host).dump}",caller)
+        end
+
+        options[:port] ||= @esmtp_port
+        options[:login] ||= @esmtp_login
+        options[:user] ||= @esmtp_user
+        options[:password] ||= @esmtp_password
+
+        return ::Net.esmtp_connect(@esmtp_host,options,&block)
+      end
+
+      def esmtp_session(options={},&block)
+        esmtp_connect(options) do |sess|
+          block.call(sess) if block
+          sess.close
+        end
+      end
+    end
+  end
+end

data/lib/ronin/sessions/imap.rb

@@ -0,0 +1,73 @@
+#
+#--
+# Ronin - A ruby development platform designed for information security
+# and data exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/sessions/session'
+require 'ronin/network/imap'
+
+module Ronin
+  module Sessions
+    module IMAP
+      include Session
+
+      IMAP_SESSION = proc do
+        parameter :imap_host, :description => 'IMAP host'
+        parameter :imap_port, :description => 'IMAP port'
+
+        parameter :imap_auth, :description => 'IMAP authentication mode'
+        parameter :imap_user, :description => 'IMAP user'
+        parameter :imap_password, :description => 'IMAP password'
+      end
+
+      def self.included(base)
+        Session.setup_class(base,&IMAP_SESSION)
+      end
+
+      def self.extended(obj)
+        Session.setup_object(obj,&IMAP_SESSION)
+      end
+
+      protected
+
+      def imap_connect(options={},&block)
+        unless @imap_host
+          raise(ParamNotFound,"Missing parameter '#{describe_param(:imap_host)}'",caller)
+        end
+
+        options[:port] ||= @imap_port
+        options[:auth] ||= @imap_auth
+        options[:user] ||= @imap_user
+        options[:password] ||= @imap_password
+
+        return ::Net.imap_connect(@imap_host,options,&block)
+      end
+
+      def imap_session(options={},&block)
+        imap_connect(options) do |sess|
+          block.call(sess) if block
+          sess.close
+          sess.logout
+        end
+      end
+    end
+  end
+end

data/lib/ronin/sessions/pop3.rb

@@ -0,0 +1,70 @@
+#
+#--
+# Ronin - A ruby development platform designed for information security
+# and data exploration tasks.
+#
+# Copyright (c) 2006-2008 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'ronin/sessions/session'
+require 'ronin/network/pop3'
+
+module Ronin
+  module Sessions
+    module POP3
+      include Session
+
+      POP3_SESSION = proc do
+        parameter :pop3_host, :description => 'POP3 host'
+        parameter :pop3_port, :description => 'POP3 port'
+
+        parameter :pop3_user, :description => 'POP3 user'
+        parameter :pop3_password, :description => 'POP3 password'
+      end
+
+      def self.included(base)
+        Session.setup_class(base,&POP3_SESSION)
+      end
+
+      def self.extended(obj)
+        Session.setup_object(obj,&POP3_SESSION)
+      end
+
+      protected
+
+      def pop3_connect(options={},&block)
+        unless @pop3_host
+          raise(ParamNotFound,"Missing parameter #{describe_param(:pop3_host).dump}",caller)
+        end
+
+        options[:port] ||= @pop3_port
+        options[:user] ||= @pop3_user
+        options[:password] ||= @pop3_password
+
+        return ::Net.pop3_connect(@pop3_host,options,&block)
+      end
+
+      def pop3_session(options={},&block)
+        pop3_connect(options) do |sess|
+          block.call(sess) if block
+          sess.finish
+        end
+      end
+    end
+  end
+end