ronin 0.3.0 → 1.0.0.pre1

data/lib/ronin/ui/cli/commands/database.rb

@@ -0,0 +1,179 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/ui/cli/command'
+require 'ronin/database'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        #
+        # The `ronin database` command.
+        #
+        class Database < Command
+
+          desc "Manages the Ronin Database"
+          class_option :add, :type => :string, :banner => 'NAME', :aliases => '-a'
+          class_option :set, :type => :string, :banner => 'NAME', :aliases => '-s'
+          class_option :remove, :type => :string, :banner => 'NAME', :aliases => '-r'
+          class_option :clear, :type => :string, :banner => 'NAME', :aliases => '-C'
+          
+          # repository options
+          class_option :uri, :type => :string, :banner => 'sqlite3:///path'
+          class_option :adapter, :type => :string, :banner => 'sqlite3'
+          class_option :host, :type => :string, :banner => 'www.example.com'
+          class_option :port, :type => :numeric, :banner => '9999'
+          class_option :user, :type => :string
+          class_option :password, :type => :string
+          class_option :database, :type => :string, :banner => 'NAME'
+          class_option :path, :type => :string, :banner => '/path/file.db'
+
+          #
+          # Displays or modifies the Ronin Database configuration.
+          #
+          def execute
+            if options[:clear]
+              name = options[:clear].to_sym
+
+              print_info "Clearing the Database repository #{name} ..."
+
+              Ronin::Database.clear(name) do
+                print_info "Database repository #{name} cleared."
+              end
+
+              return
+            end
+
+            if options[:add]
+              add_repository
+            elsif options[:set]
+              set_repository
+            elsif options[:delete]
+              delete_repository
+            else
+              indent do
+                Ronin::Database.repositories.each do |name,uri|
+                  puts "#{name}: #{uri}"
+                end
+              end
+            end
+          end
+
+          protected
+
+          #
+          # Creates a repository URI from the command options.
+          #
+          # @return [Addressable::URI]
+          #   The repository URI.
+          #
+          def repository_uri
+            uri = if options[:uri]
+                    Addressable::URI.parse(options[:uri])
+                  else
+                    Addressable::URI.new()
+                  end
+
+            uri.scheme = options[:adapter] if options[:adapter]
+            uri.host = options[:host] if options[:host]
+            uri.port = options[:port] if options[:port]
+            uri.user = options[:user] if options[:user]
+            uri.password = options[:password] if options[:password]
+
+            if options[:database]
+              uri.path = options[:database]
+            elsif options[:path]
+              uri.path = options[:path]
+            end
+
+            return uri
+          end
+
+          #
+          # Adds a new Database repository.
+          #
+          def add_repository
+            name = options[:add].to_sym
+
+            Ronin::Database.save do
+              Ronin::Database.repositories[name] = repository_uri
+            end
+
+            print_info "Database repository #{name} added."
+          end
+
+          #
+          # Sets the URI for an existing Database repository.
+          #
+          def set_repository
+            name = options[:set].to_sym
+
+            unless Ronin::Database.repository?(name)
+              print_error "Unknown Database repository #{name}"
+              return
+            end
+
+            Ronin::Database.save do
+              if options[:uri]
+                Ronin::Database.repositories[name] = repository_uri
+              else
+                uri = Ronin::Database.repositories[name]
+
+                uri.scheme = options[:adapter] if options[:adapter]
+                uri.host = options[:host] if options[:host]
+                uri.port = options[:port] if options[:port]
+                uri.user = options[:user] if options[:user]
+                uri.password = options[:password] if options[:password]
+
+                if options[:database]
+                  uri.path = options[:database]
+                elsif options[:path]
+                  uri.path = options[:path]
+                end
+              end
+            end
+
+            print_info "Database repository #{name} updated."
+          end
+
+          #
+          # Removes an existing Database repository.
+          #
+          def remove_repository
+            name = options[:remove].to_sym
+
+            unless Ronin::Database.repository?(name)
+              print_error "Unknown Database repository #{name}"
+              return
+            end
+
+            Ronin::Database.save do
+              Ronin::Database.repositories.delete(name)
+            end
+
+            print_info "Database repository #{name} removed."
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/cli/commands/emails.rb

@@ -0,0 +1,108 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/ui/cli/model_command'
+require 'ronin/email_address'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        #
+        # The `ronin-emails` command.
+        #
+        class Emails < ModelCommand
+
+          self.model = EmailAddress
+
+          query_option :hosts, :type => :array, :aliases => '-H' do |emails,hosts|
+            emails.all('host_name.address' => hosts)
+          end
+
+          query_option :ip, :type => :array, :aliases => '-I' do |emails,ips|
+            hosts.all('host_name.ip_addresses.address' => ips)
+          end
+
+          query_option :ports, :type => :array, :aliases => '-p' do |emails,ports|
+            emails.all('host_name.ports.number' => ports)
+          end
+
+          query_option :users, :type => :array, :aliases => '-u' do |emails,users|
+            emails.all('user_name.name' => users)
+          end
+
+          class_option :list, :type => :boolean,
+                              :default => true,
+                              :aliases => '-l'
+
+          class_option :import, :type => :string,
+                                :aliases => '-i',
+                                :banner => 'FILE'
+
+          #
+          # Queries the {EmailAddress} model.
+          #
+          # @since 1.0.0
+          #
+          def execute
+            if options[:import]
+              import options[:import]
+            elsif options.list?
+              super
+            end
+          end
+
+          protected
+
+          #
+          # Imports email addresses from a file.
+          #
+          # @param [String] path
+          #   The path to the file.
+          #
+          # @since 1.0.0
+          #
+          def import(path)
+            File.open(path) do |file|
+              file.each_line do |line|
+                line.strip!
+                next if line.empty?
+
+                email = begin
+                          EmailAddress.parse(line)
+                        rescue => e
+                          print_error e.message
+                          next
+                        end
+
+                if email.save
+                  print_info "Imported #{email}"
+                else
+                  print_error "Unable to import #{line.dump}."
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/cli/commands/exec.rb

@@ -0,0 +1,124 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/ui/output/helpers'
+require 'ronin/repository'
+require 'ronin/database'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        #
+        # The `ronin exec` command.
+        #
+        class Exec
+
+          include Output::Helpers
+
+          #
+          # Initializes the `exec` command.
+          #
+          # @param [String] script
+          #   The name or path of the script to run.
+          #
+          # @param [Array<String>] arguments
+          #   The arguments to the script with.
+          #
+          # @since 1.0.0
+          #
+          def initialize(script,arguments=[])
+            @script = script
+            @arguments = arguments
+          end
+
+          #
+          # Runs the `exec` command.
+          #
+          # @param [Array<String>] argv
+          #   The arguments to run the `exec` command with.
+          #
+          def self.start(argv=ARGV)
+            case argv[0]
+            when '-h', '--help', nil
+              puts "Usage:\n  ronin-exec SCRIPT [ARGS...]\n\n"
+              puts "Runs a script from a Ronin Repository"
+              return false
+            end
+
+            self.new(argv[0],argv[1..-1]).execute
+          end
+
+          #
+          # Executes the `exec` command.
+          #
+          # @since 1.0.0
+          #
+          def execute
+            if File.file?(@script)
+              require 'ronin'
+
+              setup_argv { load File.expand_path(@script) }
+              return true
+            end
+
+            Database.setup
+
+            Repository.each do |repo|
+              path = repo.path.join(Repository::BIN_DIR,@script)
+
+              if path.file?
+                require 'ronin'
+
+                repo.activate!
+
+                setup_argv { load path }
+                return true
+              end
+            end
+
+            print_error "Could not find the script #{@script.dump}."
+            return false
+          end
+
+          protected
+
+          #
+          # Temporarily populates the `ARGV` constant.
+          #
+          # @since 1.0.0
+          #
+          def setup_argv
+            original_argv = ARGV.dup
+            ARGV.clear
+            @arguments.each { |arg| ARGV << arg }
+
+            result = yield
+
+            ARGV.clear
+            original_argv.each { |arg| ARGV << arg }
+            return result
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/ui/{command_line → cli}/commands/help.rb

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 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
@@ -18,31 +18,34 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
-require 'ronin/ui/command_line/command'
-require 'ronin/ui/command_line/command_line'
+require 'ronin/ui/cli/command'
+require 'ronin/ui/cli/command_line'
 
 module Ronin
   module UI
-    module CommandLine
+    module CLI
       module Commands
+        #
+        # The `ronin help` command.
+        #
         class Help < Command
 
-          desc "help [COMMAND]", "Displays the list of available commands or prints information on a specific command"
+          desc 'Displays the list of available commands or prints information on a specific command'
+          argument :command, :type => :string, :required => false
 
-          def default(command=nil)
-            if command
+          #
+          # Lists the available commands.
+          #
+          def execute
+            if self.command
               begin
-                CommandLine.get_command(command).start(['--help'])
+                CommandLine.command(self.command).start(['--help'])
               rescue UnknownCommand
                 print_error "unknown command #{command.dump}"
-                exit -1
               end
             else
-              puts 'Available commands:'
-
-              indent do
-                CommandLine.commands.sort.each { |name| puts name }
-              end
+              print_array CommandLine.commands.keys.sort,
+                          :title => 'Available commands'
             end
           end
 

data/lib/ronin/ui/cli/commands/hosts.rb

@@ -0,0 +1,177 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/ui/cli/model_command'
+require 'ronin/host_name'
+
+module Ronin
+  module UI
+    module CLI
+      module Commands
+        #
+        # The `ronin-hosts` command.
+        #
+        class Hosts < ModelCommand
+
+          self.model = HostName
+
+          query_option :with_ips, :type => :array,
+                                  :aliases => '-I',
+                                  :banner => 'IP [...]'
+
+          query_option :with_ports, :type => :array,
+                                    :aliases => '-p',
+                                    :banner => 'PORT [...]'
+
+          query_option :domain, :type => :string,
+                                :aliases => '-D',
+                                :banner => 'DOMAIN'
+
+          query_option :tld, :type => :string,
+                             :aliases => '-T',
+                             :banner => 'TLD'
+
+          class_option :list, :type => :boolean,
+                              :default => true,
+                              :aliases => '-l'
+
+          class_option :lookup, :type => :string,
+                                :aliases => '-L',
+                                :banner => 'IP'
+
+          class_option :import, :type => :string,
+                                :aliases => '-i',
+                                :banner => 'FILE'
+
+          #
+          # Queries the {HostName} model.
+          #
+          # @since 1.0.0
+          #
+          def execute
+            if options[:import]
+              import options[:import]
+            elsif options[:lookup]
+              lookup options[:lookup]
+            elsif options.list?
+              super
+            end
+          end
+
+          protected
+
+          #
+          # Looks up an IP address.
+          #
+          # @param [String] ip
+          #   The IP address to look up.
+          #
+          # @since 1.0.0
+          #
+          def lookup(ip)
+            Database.setup
+
+            print_info "Looking up #{ip} ..."
+
+            HostName.lookup(ip).each { |host| print_info "  #{host}" }
+
+            print_info "Looking up #{ip}"
+          end
+
+          #
+          # Imports host names from a file.
+          #
+          # @param [String] path
+          #   The path to the file.
+          #
+          # @since 1.0.0
+          #
+          def import(path)
+            Database.setup
+
+            File.open(path) do |file|
+              file.each_line do |line|
+                line.strip!
+                next if line.empty?
+
+                host = HostName.new(:address => line)
+
+                if host.save
+                  print_info "Imported #{host}"
+                else
+                  print_error "Unable to import #{line.dump}."
+                end
+              end
+            end
+          end
+
+          #
+          # Prints a host name.
+          #
+          # @param [HostName] host
+          #   The host name to print.
+          #
+          # @since 1.0.0
+          #
+          def print_resource(host)
+            return super(host) unless options.verbose?
+
+            print_title host.address
+
+            indent do
+              if (org = host.organization)
+                print_hash('Organization' => org)
+              end
+
+              if (last_scanned_at = host.last_scanned_at)
+                print_hash('Last Scanned' => last_scanned_at)
+              end
+
+              unless host.ip_addresses.empty?
+                print_array host.ip_addresses, :title => 'IP Addresses'
+              end
+
+              unless host.open_ports.empty?
+                print_section 'Open Ports' do
+                  host.open_ports.each do |port|
+                    if port.service
+                      puts "#{port}\t#{port.service}"
+                    else
+                      puts port
+                    end
+                  end
+                end
+              end
+
+              unless host.email_addresses.empty?
+                print_array host.email_addresses, :title => 'Email Addresses'
+              end
+
+              unless host.urls.empty?
+                print_array host.urls, :title => 'URLs'
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end