ronin 0.1.1 → 0.1.2

data/lib/ronin/ui/command_line/commands/add.rb

@@ -0,0 +1,75 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/command_line/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module UI
+    module CommandLine
+      class AddCommand < Command
+
+        command :add
+
+        def define_options(opts)
+          opts.usage = 'PATH [options]'
+
+          opts.options do
+            opts.on('-m','--media MEDIA','Spedify the media-type of the repository') do |media|
+              @media = media
+            end
+
+            opts.on('-U','--uri URI','Specify the source URI of the repository') do |uri|
+              @uri = uri
+            end
+
+            opts.on('-L','--local','Similiar to: --media local') do
+              @media = :local
+            end
+          end
+
+          opts.arguments(
+            'PATH' => 'Add the repository located at the specified PATH'
+          )
+
+          opts.summary('Add a local repository located at the specified PATH to the repository cache')
+        end
+
+        def arguments(*args)
+          unless args.length == 1
+            fail('only one repository path maybe specified')
+          end
+
+          path = args.first
+
+          Cache::Overlay.save_cache do
+            Cache::Overlay.add(path,@media,@uri) do |repo|
+              puts "Overlay #{repo} added."
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -21,30 +21,39 @@
 #++
 #
 
-require 'ronin/program/command'
+require 'ronin/ui/command_line/command'
+require 'ronin/cache/overlay'
 
 module Ronin
-  module Program
-    class HelpCommand < Command
-
-      command :help
-
-      options('[COMMAND]') do |opts|
-        opts.arguments do
-          opts.arg('COMMAND','The command to view')
+  module UI
+    module CommandLine
+      class DefaultCommand < Command
+
+        def define_options(opts)
+          opts.usage = '<command> [options]'
+          opts.options do
+            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
+              CommandLine.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.
+          }
         end
 
-        opts.summary('View a list of supported commands or information on a specific command')
-      end
-
-      def arguments(*args)
-        unless args.length<=1
-          fail('help: only one command maybe specified')
+        def arguments(*args)
+          Console.start
         end
 
-        success { Program.help(args.first) }
       end
-
     end
   end
 end

data/lib/ronin/ui/command_line/commands/extension.rb

@@ -0,0 +1,85 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/command_line/command'
+require 'ronin/cache/extension'
+require 'ronin/config'
+
+require 'fileutils'
+require 'erb'
+
+module Ronin
+  module UI
+    module CommandLine
+      class ExtensionCommand < Command
+
+        command :extension, :ext
+
+        def initialize
+          @uses = []
+
+          super
+        end
+
+        def define_options(opts)
+          opts.usage = '[options] PATH'
+
+          opts.options do
+            opts.on('-u','--uses NAME','Name of an other extension to use') do |name|
+              @uses << name
+            end
+          end
+
+          opts.arguments(
+            'PATH' => 'The PATH of the Extension to be created'
+          )
+
+          opts.summary('Create an empty Extension at the specified PATH')
+        end
+
+        def arguments(*args)
+          unless args.length == 1
+            fail('only one Extension path maybe specified')
+          end
+
+          path = File.expand_path(args.first)
+          extension_path = File.join(path,Cache::Extension::EXTENSION_FILE)
+          lib_dir = File.join(path,Cache::Extension::LIB_DIR)
+
+          FileUtils.mkdir_p(path)
+          FileUtils.mkdir_p(lib_dir)
+          FileUtils.touch(File.join(lib_dir,File.basename(path) + '.rb'))
+          FileUtils.mkdir_p(File.join(lib_dir,File.basename(path)))
+
+          File.open(extension_path,'w') do |file|
+            template_path = File.join(Config::STATIC_DIR,'extension.rb.erb')
+            template = ERB.new(File.read(template_path))
+
+            file.write(template.result(binding))
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/ui/command_line/commands/help.rb

@@ -0,0 +1,70 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/command_line/command'
+
+module Ronin
+  module UI
+    module CommandLine
+      class HelpCommand < Command
+
+        command :help
+
+        def define_options(opts)
+          opts.usage = '[COMMAND]'
+
+          opts.arguments(
+            'COMMAND' => 'The command to view'
+          )
+
+          opts.summary('View a list of supported commands or information on a specific command')
+        end
+
+        def arguments(*args)
+          if args.length > 1
+            fail('only one command maybe specified')
+          end
+
+          topic = args.first
+
+          if topic
+            begin
+              CommandLine.get_command(topic).help
+            rescue UnknownCommand => exp
+              CommandLine.fail(exp)
+            end
+          else
+            puts 'Available commands:'
+
+            CommandLine.commands.sort_by { |cmd|
+              cmd.command_names.first
+            }.each { |cmd|
+              puts "  #{cmd.command_names.join(', ')}"
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/{program → ui/command_line}/commands/install.rb

@@ -21,44 +21,47 @@
 #++
 #
 
-require 'ronin/program/command'
+require 'ronin/ui/command_line/command'
 require 'ronin/cache/overlay'
 
 module Ronin
-  module Program
-    class InstallCommand < Command
+  module UI
+    module CommandLine
+      class InstallCommand < Command
 
-      command :install
+        command :install
 
-      options('URI [options]') do |opts|
-        opts.settings.media = nil
-        opts.settings.uri = nil
+        def define_options(opts)
+          opts.usage = 'URI [options]'
 
-        opts.options do
-          opts.on('-m','--media [MEDIA]','Spedify the media-type of the repository') do |media|
-            options.settings.media = media
+          opts.options do
+            opts.on('-m','--media [MEDIA]','Spedify the media-type of the repository') do |media|
+              @media = media
+            end
           end
-        end
 
-        opts.arguments do
-          opts.arg('URI','The URI of the repository to install')
+          opts.arguments(
+            'URI' => 'The URI of the repository to install'
+          )
+
+          opts.summary('Installs the repository located at the specified URI')
         end
 
-        opts.summary('Installs the repository located at the specified URI')
-      end
+        def arguments(args)
+          unless args.length == 1
+            fail('only one repository URI maybe specified')
+          end
 
-      def arguments(args)
-        unless args.length==1
-          fail('install: only one repository URI maybe specified')
-        end
+          uri = args.first
 
-        Cache::Overlay.save_cache do
-          Cache::Overlay.install(:uri => args.first, :media => options.settings.media) do |repo|
-            puts "Overlay #{repo} has been installed."
+          Cache::Overlay.save_cache do
+            Cache::Overlay.install(:uri => uri, :media => @media) do |repo|
+              puts "Overlay #{repo} has been installed."
+            end
           end
         end
-      end
 
+      end
     end
   end
 end

data/lib/ronin/ui/command_line/commands/list.rb

@@ -0,0 +1,93 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2007 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/command_line/command'
+require 'ronin/cache/overlay'
+
+module Ronin
+  module UI
+    module CommandLine
+      class ListCommand < Command
+
+        command :list, :ls
+
+        def define_options(opts)
+          opts.usage = '[NAME ...] [options]'
+
+          opts.options do
+            opts.on('-v','--verbose','Enable verbose output') do
+              @verbose = true
+            end
+          end
+
+          opts.arguments(
+            'NAME' => 'Overlay to display'
+          )
+
+          opts.summary('Display all or the specified repositories within the repository cache')
+        end
+
+        def arguments(*args)
+          if args.empty?
+            # list all repositories by name
+            Cache::Overlay.each { |repo| puts "  #{repo}" }
+            return
+          end
+
+          # list specified repositories
+          args.each do |name|
+            overlay = Cache::Overlay.get(name)
+
+            puts "[ #{overlay.name} ]\n\n"
+
+            puts "  Path: #{overlay.path}"
+            puts "  Media: #{overlay.media}" if overlay.media
+            puts "  URI: #{overlay.uri}" if overlay.uri
+
+            if @verbose
+              if overlay.source
+                puts "  Source URI: #{overlay.source}"
+              end
+
+              if overlay.source_view
+                puts "  Source View: #{overlay.source_view}"
+              end
+
+              if overlay.website
+                puts "  Website: #{overlay.website}"
+              end
+
+              if overlay.description
+                puts "  Description:\n\n    #{overlay.description}"
+              end
+
+              puts "  Extensions:\n\n"
+              overlay.each_extension { |ext| puts "    #{ext.name}" }
+            end
+          end
+        end
+
+      end
+    end
+  end
+end