ronin 1.4.1 → 1.5.0.rc1

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

@@ -67,10 +67,10 @@ module Ronin
                                 :usage       => 'TITLE',
                                 :description => 'Title to filter by'
 
-          query_option :describing, :type    => String,
-                                    :flag    => '-d',
-                                    :usage   => 'DESC',
-                                    :desc    => 'Description to filter by'
+          query_option :describing, :type        => String,
+                                    :flag        => '-d',
+                                    :usage       => 'DESC',
+                                    :description => 'Description to filter by'
 
           query_option :licensed_under, :type        => String,
                                         :flag        => '-L',

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

@@ -43,6 +43,11 @@ module Ronin
         #
         #       REPO                             Repository to uninstall
         #
+        # ## Examples
+        # 
+        #       ronin uninstall repo
+        #       ronin uninstall repo@github.com
+        #
         class Uninstall < Command
 
           summary 'Uninstalls Ronin Repositories'
@@ -50,6 +55,11 @@ module Ronin
           argument :repo, :type        => String,
                           :description => 'Repository to uninstall'
 
+          examples [
+            "ronin uninstall repo",
+            "ronin uninstall repo@github.com"
+          ]
+
           #
           # Sets up the install command.
           #

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

@@ -43,6 +43,11 @@ module Ronin
         #
         #       REPO                             Repository to update
         #
+        # ## Examples
+        #
+        #       ronin update repo
+        #       ronin update repo@github.com
+        #
         class Update < Command
 
           summary 'Updates Ronin Repositories'
@@ -50,6 +55,11 @@ module Ronin
           argument :repo, :type        => String,
                           :description => 'Repository to update'
 
+          examples [
+            "ronin update repo",
+            "ronin update repo@github.com"
+          ]
+
           #
           # Sets up the install command.
           #
@@ -94,7 +104,7 @@ module Ronin
           # @param [Repository] repository
           #   The repository that was updated.
           #
-          def print_cache_errors(repo)
+          def print_cache_errors(repository)
             repository.script_paths.each do |script_path|
               if script_path.cache_exception
                 print_exception script_path.cache_exception

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

@@ -60,36 +60,45 @@ module Ronin
 
           summary 'Manages URLs'
 
-          query_option :http, :type => true
-          query_option :https, :type => true
-
-          query_option :hosts, :type  => Array,
-                               :flag  => '-H',
-                               :usage => 'HOST [...]'
-
-          query_option :ports, :type  => Array[Integer],
-                               :flag  => '-P',
-                               :usage => 'PORT [...]'
-
-          query_option :directory, :type  => String, 
-                                   :flag  => '-d',
-                                   :usage => 'SUBDIR'
-
-          query_option :with_query_param, :type  => Array,
-                                          :flag  => '-q',
-                                          :usage => 'NAME [...]'
-
-          query_option :with_query_value, :type   => Array,
-                                          :flag   => '-Q',
-                                          :usage  => 'VALUE [...]'
-
-          option :list, :type    => true,
-                        :default => true,
-                        :flag    => '-l'
-
-          option :import, :type  => String,
-                          :flag  => '-i',
-                          :usage => 'FILE'
+          query_option :http, :type        => true,
+                              :description => 'Searches for http:// URLs'
+
+          query_option :https, :type        => true,
+                               :description => 'Searches for https:// URLs'
+
+          query_option :hosts, :type        => Array,
+                               :flag        => '-H',
+                               :usage       => 'HOST [...]',
+                               :description => 'Searches for the associated HOST(s)'
+
+          query_option :ports, :type        => Array[Integer],
+                               :flag        => '-P',
+                               :usage       => 'PORT [...]',
+                               :description => 'Searches for the associated PORT(s)'
+
+          query_option :directory, :type        => String, 
+                                   :flag        => '-d',
+                                   :description => 'Searches for the associated DIRECTORY'
+
+          query_option :with_query_param, :type        => Array,
+                                          :flag        => '-q',
+                                          :usage       => 'NAME [...]',
+                                          :description => 'Searches for the associated query-param NAME(s)'
+
+          query_option :with_query_value, :type        => Array,
+                                          :flag        => '-Q',
+                                          :usage       => 'VALUE [...]',
+                                          :description => 'Searches for the associated query-param VALUE(s)'
+
+          option :list, :type        => true,
+                        :default     => true,
+                        :flag        => '-l',
+                        :description => 'Lists the URLs'
+
+          option :import, :type        => String,
+                          :flag        => '-i',
+                          :usage       => 'FILE',
+                          :description => 'Imports URLs from the FILE'
 
           protected
 

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

@@ -45,6 +45,11 @@ module Ronin
         #
         #       TEMPLATE                         Options word template (alpha:7 numeric:1-3)
         #
+        # ## Examples
+        #
+        #       ronin wordlist alpha:7 numeric:1-3
+        #       ronin wordlist --input text.txt -m e:3 -m a:@ -m o:0
+        #
         # @since 1.4.0
         #
         class Wordlist < Command
@@ -68,7 +73,12 @@ module Ronin
                              :descriptions => 'Mutations rules'
 
           argument :template, :type        => Array,
-                              :description => 'Options word template (alpha:7 numeric:1-3)'
+                              :description => 'Options word template [CHARSET:[LENGTH|RANGE] ...]'
+
+          examples [
+            "ronin wordlist alpha:7 numeric:1-3",
+            "ronin wordlist --input text.txt -m e:3 -m a:@ -m o:0"
+          ]
 
           #
           # Executes the wordlist command.

data/lib/ronin/ui/console.rb

@@ -19,3 +19,4 @@
 
 require 'ronin/ui/console/console'
 require 'ronin/ui/console/commands'
+require 'ronin/ui/console/shell'

data/lib/ronin/ui/console/commands.rb

@@ -17,125 +17,58 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/config'
-
-require 'set'
+require 'shellwords'
 require 'tempfile'
 
 module Ronin
   module UI
     module Console
       #
-      # Allows for executing shell commands prefixed by a `!`.
+      # Allows for calling {Console} commands via the `.` prefix.
+      #
+      # ## Commands
+      #
+      # * {edit .edit}
       #
       # @since 1.2.0
       #
       # @api private
       #
       module Commands
-        # Names and statuses of executables.
-        EXECUTABLES = Hash.new do |hash,key|
-          hash[key] = Config::BIN_DIRS.any? do |dir|
-            path = File.join(dir,key)
-
-            (File.file?(path) && File.executable?(path))
-          end
-        end
-
-        # Prefixes that denote a command, instead of Ruby code.
-        PREFIXES = Set['!', '.']
-
-        # Blacklist of known commands that conflict with Ruby keywords.
-        BLACKLIST = Set[
-          '[', 'ap', 'begin', 'case', 'class', 'def', 'fail', 'false',
-          'for', 'if', 'lambda', 'load', 'loop', 'module', 'p', 'pp',
-          'print', 'proc', 'puts', 'raise', 'require', 'true', 'undef',
-          'unless', 'until', 'warn', 'while'
-        ]
+        # Regexp to recognize `.commands`.
+        PATTERN = /^\.[a-z][a-z0-9_]*/
 
         #
-        # Dynamically execute shell commands, instead of Ruby.
+        # Check for the `.` prefix, and attempt to call the Console command.
         #
         # @param [String] input
         #   The input from the console.
         #
         def loop_eval(input)
-          if PREFIXES.include?(input[0,1])
+          if (@buffer.nil? && input =~ PATTERN)
             command = input[1..-1]
-            name, arguments = command.split(' ')
+            name, arguments = Shellwords.shellsplit(command)
 
-            unless BLACKLIST.include?(name)
-              if Commands.singleton_class.method_defined?(name)
-                arguments ||= []
+            if Commands.singleton_class.method_defined?(name)
+              arguments ||= []
 
-                return Commands.send(name,*arguments)
-              elsif executable?(name)
-                return system(command)
-              end
+              return Commands.send(name,*arguments)
             end
           end
 
           super(input)
         end
 
-        #
-        # Equivalent of the `cd` command, using `Dir.chdir`.
-        #
-        # @param [Array<String>] arguments
-        #   The arguments of the command.
-        #
-        # @return [Boolean]
-        #   Specifies whether the directory change was successful.
-        #
-        def Commands.cd(*arguments)
-          old_pwd = Dir.pwd
-
-          new_cwd = if arguments.empty?
-                      Config::HOME
-                    elsif arguments.first == '-'
-                      unless ENV['OLDPWD']
-                        print_warning 'cd: OLDPWD not set'
-                        return false
-                      end
-
-                      ENV['OLDPWD']
-                    else
-                      arguments.first
-                    end
-
-          Dir.chdir(new_cwd)
-          ENV['OLDPWD'] = old_pwd
-          return true
-        end
-
-        #
-        # Equivalent of the `export` or `set` commands.
-        #
-        # @param [Array<String>] arguments
-        #   The arguments of the command.
-        #
-        # @return [true]
-        #
-        def Commands.export(*arguments)
-          arguments.each do |pair|
-            name, value = pair.split('=',2)
-
-            ENV[name] = value
-          end
-        end
-
         #
         # Edits a path and re-loads the code.
         #
-        # @param [Array<String>] path 
+        # @param [String] path 
         #   The path of the file to re-load.
         #
         # @return [Boolean]
         #   Specifies whether the code was successfully re-loaded.
         #
-        def Commands.edit(*arguments)
-          path = arguments.first
-
+        def self.edit(path=nil)
           if ENV['EDITOR']
             path ||= Tempfile.new(['ronin-console', '.rb']).path
 
@@ -145,21 +78,6 @@ module Ronin
             return false
           end
         end
-
-        protected
-
-        #
-        # Determines if an executable exists on the system.
-        #
-        # @param [String] name
-        #   The program name or path.
-        #
-        # @return [Boolean]
-        #   Specifies whether the executable exists.
-        #
-        def executable?(name)
-          (File.file?(name) && File.executable?(name)) || EXECUTABLES[name]
-        end
       end
     end
   end

data/lib/ronin/ui/console/shell.rb

@@ -0,0 +1,184 @@
+#
+# Copyright (c) 2006-2012 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin.
+#
+# Ronin 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 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin 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 Ronin.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/config'
+
+require 'set'
+require 'shellwords'
+
+module Ronin
+  module UI
+    module Console
+      #
+      # Allows for executing shell commands prefixed by a `!`.
+      #
+      # @since 1.5.0
+      #
+      # @api private
+      #
+      module Shell
+        # Names and statuses of executables.
+        EXECUTABLES = Hash.new do |hash,key|
+          hash[key] = Config::BIN_DIRS.any? do |dir|
+            path = File.join(dir,key)
+
+            (File.file?(path) && File.executable?(path))
+          end
+        end
+
+        # Regexp to recognize `!commands`.
+        PATTERN = /^![a-zA-Z][a-zA-Z0-9\._-]*/
+
+        # Blacklist of known commands that conflict with Ruby keywords.
+        BLACKLIST = Set[
+          '[', 'ap', 'begin', 'case', 'class', 'def', 'fail', 'false',
+          'for', 'if', 'lambda', 'load', 'loop', 'module', 'p', 'pp',
+          'print', 'proc', 'puts', 'raise', 'require', 'true', 'undef',
+          'unless', 'until', 'warn', 'while'
+        ]
+
+        #
+        # Dynamically execute shell commands, instead of Ruby.
+        #
+        # @param [String] input
+        #   The input from the console.
+        #
+        def loop_eval(input)
+          if (@buffer.nil? && input =~ PATTERN)
+            command = input[1..-1]
+            name, arguments = parse_command(command)
+
+            unless BLACKLIST.include?(name)
+              if Shell.singleton_class.method_defined?(name)
+                arguments ||= []
+
+                return Shell.send(name,*arguments)
+              elsif executable?(name)
+                return Shell.exec(name,*arguments)
+              end
+            end
+          end
+
+          super(input)
+        end
+
+        #
+        # Default command which executes a command in the shell.
+        #
+        # @param [Array<String>] arguments
+        #   The arguments of the command.
+        #
+        # @return [Boolean]
+        #   Specifies whether the command exited successfully.
+        #
+        # @since 1.5.0
+        #
+        def self.exec(*arguments)
+          system(Shellwords.shelljoin(arguments))
+        end
+
+        #
+        # Equivalent of the `cd` command, using `Dir.chdir`.
+        #
+        # @param [Array<String>] arguments
+        #   The arguments of the command.
+        #
+        # @return [Boolean]
+        #   Specifies whether the directory change was successful.
+        #
+        def self.cd(*arguments)
+          old_pwd = Dir.pwd
+
+          new_cwd = if arguments.empty?
+                      Config::HOME
+                    elsif arguments.first == '-'
+                      unless ENV['OLDPWD']
+                        print_warning 'cd: OLDPWD not set'
+                        return false
+                      end
+
+                      ENV['OLDPWD']
+                    else
+                      arguments.first
+                    end
+
+          Dir.chdir(new_cwd)
+          ENV['OLDPWD'] = old_pwd
+          return true
+        end
+
+        #
+        # Equivalent of the `export` or `set` commands.
+        #
+        # @param [Array<String>] arguments
+        #   The arguments of the command.
+        #
+        # @return [true]
+        #
+        def self.export(*arguments)
+          arguments.each do |pair|
+            name, value = pair.split('=',2)
+
+            ENV[name] = value
+          end
+        end
+
+        protected
+
+        #
+        # Parses a Console command.
+        #
+        # @param [String] command
+        #   The Console command to parse.
+        #
+        # @return [String, Array<String>]
+        #   The command name and additional arguments.
+        #
+        # @since 1.5.0
+        #
+        def parse_command(command)
+          # evaluate embedded Ruby expressions
+          command = command.gsub(/\#\{[^\}]*\}/) do |expression|
+            eval(expression[2..-2],Ripl.config[:binding]).to_s.dump
+          end
+
+          arguments = Shellwords.shellsplit(command)
+          name      = arguments.shift
+
+          return name, arguments
+        end
+
+        #
+        # Determines if an executable exists on the system.
+        #
+        # @param [String] name
+        #   The program name or path.
+        #
+        # @return [Boolean]
+        #   Specifies whether the executable exists.
+        #
+        def executable?(name)
+          (File.file?(name) && File.executable?(name)) || EXECUTABLES[name]
+        end
+      end
+    end
+  end
+end
+
+Ripl::Shell.send :include, Ronin::UI::Console::Shell