ronin 1.3.0 → 1.4.0.rc1

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

@@ -31,29 +31,37 @@ module Ronin
 
           model Campaign 
 
-          query_option :named, :type => :string,
-                               :aliases => '-n'
-
-          query_option :describing, :type => :string, :aliases => '-d'
-
-          query_option :targeting, :type => :array,
-                                   :aliases => '-T',
-                                   :banner => 'ADDR [...]'
-
-          query_option :targeting_orgs, :type => :array,
-                                        :aliases => '-O',
-                                        :banner => 'NAME [...]'
-
-          class_option :list, :type => :boolean,
-                              :default => true,
-                              :aliases => '-l'
-
-          class_option :add, :type => :string,
-                             :aliases => '-a',
-                             :banner => 'NAME'
-
-          class_option :targets, :type => :array,
-                                 :banner => 'ADDR [...]'
+          query_option :named, :type => String,
+                               :flag => '-n',
+                               :description => 'Name to search for'
+
+          query_option :describing, :type => String,
+                                    :flag => '-d',
+                                    :description => 'Description to search for'
+
+          query_option :targeting, :type  => Array,
+                                   :flag  => '-T',
+                                   :usage => 'ADDR [...]',
+                                   :description => 'Addresses to search for'
+
+          query_option :targeting_orgs, :type  => Array,
+                                        :flag  => '-O',
+                                        :usage => 'NAME [...]',
+                                        :description => 'Orgs to search for'
+
+          option :list, :type    => true,
+                        :default => true,
+                        :flag    => '-l',
+                        :description => 'List all Campaigns'
+
+          option :add, :type  => String,
+                       :flag  => '-a',
+                       :usage => 'NAME',
+                       :description => 'Create a new Campaign'
+
+          option :targets, :type  => Array,
+                           :usage => 'ADDR [...]',
+                           :description => 'Addresses to target'
 
           #
           # Queries the {Campaign} model.
@@ -61,9 +69,9 @@ module Ronin
           # @since 1.0.0
           #
           def execute
-            if options[:add]
-              add options[:add]
-            elsif options.list?
+            if add?
+              add(@add)
+            elsif list?
               super
             end
           end
@@ -81,8 +89,10 @@ module Ronin
           def add(name)
             campaign = Campaign.new(:name => name)
 
-            # add targets to the campaign
-            options[:targets].each { |target| campaign.target!(target) }
+            if targets?
+              # add targets to the campaign
+              @targets.each { |target| campaign.target!(target) }
+            end
 
             if campaign.save
               print_info "Added campaign #{campaign}"
@@ -100,7 +110,7 @@ module Ronin
           # @since 1.0.0
           #
           def print_resource(campaign)
-            return super(campaign) unless options.verbose?
+            return super(campaign) unless verbose?
 
             print_title campaign.name
 

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

@@ -32,34 +32,43 @@ module Ronin
         #
         class Console < Command
 
-          desc 'start the Ronin Console'
-          class_option :database, :type => :string, :aliases => '-D'
-          class_option :require, :type => :array,
-                                 :default => [],
-                                 :aliases => '-r',
-                                 :banner => 'PATH'
-          class_option :backtrace, :type => :boolean
-          class_option :verbose, :type => :boolean, :aliases => '-v'
-          class_option :version, :type => :boolean, :aliases => '-V'
+          summary 'Start the Ronin Console'
+
+          option :database, :type => URI,
+                            :flag => '-D',
+                            :description => 'The database to URI'
+
+          option :require, :type        => Array,
+                           :default     => [],
+                           :flag        => '-r',
+                           :usage       => 'PATH',
+                           :description => 'Ruby files to require'
+
+          option :backtrace, :type        => true,
+                             :description => 'Enable long backtraces'
+
+          option :version, :type        => true,
+                           :flag        => '-V',
+                           :description => 'Print the Ronin version'
 
           #
           # Starts the Ronin Console.
           #
           def execute
-            if options.version?
+            if version?
               puts "ronin #{Ronin::VERSION}"
               return
             end
 
-            UI::Console.color = !(options.color?)
-            UI::Console.short_errors = !(options.backtrace?)
+            UI::Console.color = color?
+            UI::Console.short_errors = !backtrace?
 
-            options[:require].each do |path|
+            @require.each do |path|
               UI::Console.auto_load << path
             end
 
-            if options[:database]
-              Database.repositories[:default] = options[:database]
+            if database?
+              Database.repositories[:default] = @database
             end
 
             UI::Console.start

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

@@ -18,6 +18,7 @@
 #
 
 require 'ronin/ui/cli/resources_command'
+
 require 'ronin/credential'
 require 'ronin/service_credential'
 require 'ronin/web_credential'
@@ -33,17 +34,20 @@ module Ronin
 
           model Credential
 
-          query_option :for_user, :type => :string,
-                                  :aliases => '-u',
-                                  :banner => 'USER'
+          query_option :for_user, :type  => String,
+                                  :flag  => '-u',
+                                  :usage => 'USER',
+                                  :description => 'Username to search for'
 
-          query_option :with_password, :type => :string,
-                                       :aliases => '-p',
-                                       :banner => 'PASS'
+          query_option :with_password, :type  => String,
+                                       :flag  => '-p',
+                                       :usage => 'PASS',
+                                       :description => 'Password to search for'
 
-          class_option :list, :type => :boolean,
-                              :default => true,
-                              :aliases => '-l'
+          option :list, :type    => true,
+                        :default => true,
+                        :flag    => '-l',
+                        :description => 'List all Credentials'
 
           #
           # Queries the {Credential} model.
@@ -51,9 +55,7 @@ module Ronin
           # @since 1.0.0
           #
           def execute
-            if options.list?
-              super
-            end
+            super if list?
           end
 
           protected

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

@@ -31,43 +31,66 @@ module Ronin
         #
         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'
+          summary "Manages the Ronin Database"
+
+          option :add, :type => Symbol,
+                       :flag => '-a',
+                       :usage => 'NAME'
+
+          option :set, :type  => Symbol,
+                       :flag  => '-s',
+                       :usage => 'NAME'
+
+          option :remove, :type  => Symbol,
+                          :flag => '-r',
+                          :usage => 'NAME'
+
+          option :clear, :type  => Symbol,
+                         :flag  => '-C',
+                         :usage => 'NAME'
           
           # 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'
+          option :uri, :type  => String,
+                       :usage => 'sqlite3:///path'
+
+          option :adapter, :type  => String,
+                           :usage => 'DB'
+
+          option :host, :type  => String,
+                        :usage => 'HOST'
+
+          option :port, :type  => Integer,
+                        :usage => 'PORT'
+
+          option :user, :type => String
+
+          option :password, :type => String
+
+          option :database, :type  => String,
+                            :usage => 'NAME'
+
+          option :path, :type  => String,
+                        :usage => 'PATH'
 
           #
           # Displays or modifies the Ronin Database configuration.
           #
           def execute
-            if options[:clear]
-              name = options[:clear].to_sym
-
-              print_info "Clearing the Database repository #{name} ..."
+            if clear?
+              print_info "Clearing the Database repository #{@clear} ..."
 
-              Ronin::Database.clear(name) do
-                print_info "Database repository #{name} cleared."
+              Ronin::Database.clear(@clear) do
+                print_info "Database repository #{@clear} cleared."
               end
 
               return
             end
 
-            if options[:add]
+            if add?
               add_repository
-            elsif options[:set]
+            elsif set?
               set_repository
-            elsif options[:delete]
+            elsif delete?
               delete_repository
             else
               Ronin::Database.repositories.each do |name,uri|
@@ -85,16 +108,16 @@ module Ronin
           #   The repository URI.
           #
           def repository_uri
-            if options[:uri]
-              Addressable::URI.parse(options[:uri]).to_hash
+            if uri?
+              Addressable::URI.parse(@uri).to_hash
             else
               {
-                :adapter => options[:adapter],
-                :host => options[:host],
-                :port => options[:port],
-                :user => options[:user],
-                :password => options[:password],
-                :database => (options[:database] || options[:path])
+                :adapter  => @adapter,
+                :host     => @host,
+                :port     => @port,
+                :user     => @user,
+                :password => @password,
+                :database => (@database || @path)
               }
             end
           end
@@ -103,49 +126,43 @@ module Ronin
           # Adds a new Database repository.
           #
           def add_repository
-            name = options[:add].to_sym
-
             Ronin::Database.save do
-              Ronin::Database.repositories[name] = repository_uri
+              Ronin::Database.repositories[@add] = repository_uri
             end
 
-            print_info "Database repository #{name} added."
+            print_info "Database repository #{@add} 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}"
+            unless Ronin::Database.repository?(@set)
+              print_error "Unknown Database repository #{@set}"
               return
             end
 
             Ronin::Database.save do
-              Ronin::Database.repositories[name] = repository_uri
+              Ronin::Database.repositories[@set] = repository_uri
             end
 
-            print_info "Database repository #{name} updated."
+            print_info "Database repository #{@set} 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}"
+            unless Ronin::Database.repository?(@remove)
+              print_error "Unknown Database repository #{@remove}"
               return
             end
 
             Ronin::Database.save do
-              Ronin::Database.repositories.delete(name)
+              Ronin::Database.repositories.delete(@remove)
             end
 
-            print_info "Database repository #{name} removed."
+            print_info "Database repository #{@remove} removed."
           end
 
         end

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

@@ -31,25 +31,25 @@ module Ronin
 
           model EmailAddress
 
-          query_option :with_hosts, :type => :array,
-                                    :aliases => '-H',
-                                    :banner => 'HOST [...]'
+          query_option :with_hosts, :type  => Array,
+                                    :flag  => '-H',
+                                    :usage => 'HOST [...]'
 
-          query_option :with_ips, :type => :array,
-                                  :aliases => '-I',
-                                  :banner => 'IP [...]'
+          query_option :with_ips, :type  => Array,
+                                  :flag  => '-I',
+                                  :usage => 'IP [...]'
 
-          query_option :with_users, :type => :array,
-                                    :aliases => '-u',
-                                    :banner => 'NAME [...]'
+          query_option :with_users, :type  => Array,
+                                    :flag  => '-u',
+                                    :usage => 'NAME [...]'
 
-          class_option :list, :type => :boolean,
-                              :default => true,
-                              :aliases => '-l'
+          option :list, :type    => true,
+                        :default => true,
+                        :flag    => '-l'
 
-          class_option :import, :type => :string,
-                                :aliases => '-i',
-                                :banner => 'FILE'
+          option :import, :type  => String,
+                          :flag  => '-i',
+                          :usage => 'FILE'
 
         end
       end

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

@@ -29,18 +29,19 @@ module Ronin
         #
         class Help < Command
 
-          desc 'Displays the list of available commands or prints information on a specific command'
-          argument :command, :type => :string, :required => false
+          summary 'Displays the list of available commands or prints information on a specific command'
+
+          argument :command, :type => Symbol
 
           #
           # Lists the available commands.
           #
           def execute
-            if self.command
+            if command?
               begin
-                CLI.command(self.command).start(['--help'])
+                CLI.command(@command).start(['--help'])
               rescue UnknownCommand
-                print_error "unknown command #{command.dump}"
+                print_error "unknown command: #{@command}"
               end
             else
               print_array CLI.commands, :title => 'Available commands'

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

@@ -31,33 +31,33 @@ module Ronin
 
           model HostName
 
-          query_option :with_ips, :type => :array,
-                                  :aliases => '-I',
-                                  :banner => 'IP [...]'
+          query_option :with_ips, :type  => Array,
+                                  :flag  => '-I',
+                                  :usage => 'IP [...]'
 
-          query_option :with_ports, :type => :array,
-                                    :aliases => '-p',
-                                    :banner => 'PORT [...]'
+          query_option :with_ports, :type  => Array[Integer],
+                                    :flag  => '-p',
+                                    :usage => 'PORT [...]'
 
-          query_option :domain, :type => :string,
-                                :aliases => '-D',
-                                :banner => 'DOMAIN'
+          query_option :domain, :type  => String,
+                                :flag  => '-D',
+                                :usage => 'DOMAIN'
 
-          query_option :tld, :type => :string,
-                             :aliases => '-T',
-                             :banner => 'TLD'
+          query_option :tld, :type  => String,
+                             :flag  => '-T',
+                             :usage => 'TLD'
 
-          class_option :list, :type => :boolean,
-                              :default => true,
-                              :aliases => '-l'
+          option :list, :type    => true,
+                        :default => true,
+                        :flag    => '-l'
 
-          class_option :lookup, :type => :string,
-                                :aliases => '-L',
-                                :banner => 'IP'
+          option :lookup, :type  => String,
+                          :flag  => '-L',
+                          :usage => 'IP'
 
-          class_option :import, :type => :string,
-                                :aliases => '-i',
-                                :banner => 'FILE'
+          option :import, :type  => String,
+                          :flag  => '-i',
+                          :usage => 'FILE'
 
           #
           # Queries the {HostName} model.
@@ -65,8 +65,8 @@ module Ronin
           # @since 1.0.0
           #
           def execute
-            if options[:lookup]
-              lookup options[:lookup]
+            if lookup?
+              lookup(@lookup)
             else
               super
             end
@@ -101,7 +101,7 @@ module Ronin
           # @since 1.0.0
           #
           def print_resource(host)
-            return super(host) unless options.verbose?
+            return super(host) unless verbose?
 
             print_title host.address