ronin 1.3.0 → 1.4.0.rc1

data/lib/ronin/environment.rb

@@ -21,13 +21,10 @@
 # Loads all extensions to core Ruby classes.
 #
 require 'ronin/ronin'
-require 'ronin/extensions'
-require 'ronin/formatting/extensions'
-require 'ronin/network/extensions'
-require 'ronin/ui/output/helpers'
+require 'ronin/support'
 
 #
-# Includes the Ronin namespace and output helper methods.
+# Includes the Ronin namespace and additional helper methods.
 #
 include Ronin
-include Ronin::UI::Output::Helpers
+include Ronin::Support

data/lib/ronin/host_name.rb

@@ -21,9 +21,7 @@ require 'ronin/extensions/regexp'
 require 'ronin/extensions/resolv'
 require 'ronin/model/importable'
 require 'ronin/address'
-require 'ronin/host_name_ip_address'
-require 'ronin/email_address'
-require 'ronin/url'
+require 'ronin/ip_address'
 
 require 'uri/generic'
 require 'strscan'

data/lib/ronin/host_name_ip_address.rb

@@ -18,8 +18,6 @@
 #
 
 require 'ronin/model'
-require 'ronin/host_name'
-require 'ronin/ip_address'
 
 require 'dm-timestamps'
 

data/lib/ronin/ip_address.rb

@@ -21,10 +21,7 @@ require 'ronin/extensions/ip_addr'
 require 'ronin/extensions/resolv'
 require 'ronin/model/importable'
 require 'ronin/address'
-require 'ronin/ip_address_mac_address'
-require 'ronin/host_name_ip_address'
-require 'ronin/os'
-require 'ronin/open_port'
+require 'ronin/host_name'
 
 require 'ipaddr'
 

data/lib/ronin/ip_address_mac_address.rb

@@ -18,8 +18,6 @@
 #
 
 require 'ronin/model'
-require 'ronin/ip_address'
-require 'ronin/mac_address'
 
 require 'dm-timestamps'
 

data/lib/ronin/mac_address.rb

@@ -19,8 +19,6 @@
 
 require 'ronin/extensions/regexp'
 require 'ronin/address'
-require 'ronin/ip_address'
-require 'ronin/ip_address_mac_address'
 
 require 'strscan'
 

data/lib/ronin/model/has_unique_name.rb

@@ -51,6 +51,23 @@ module Ronin
       # Class methods that will be added when {HasUniqueName} is included.
       #
       module ClassMethods
+        #
+        # Parses a unique name.
+        #
+        # @param [String] name
+        #   The name to parse.
+        #
+        # @return [Model]
+        #   A new or previously saved resource.
+        #
+        # @since 1.4.0
+        #
+        # @api public
+        #
+        def parse(name)
+          first_or_new(:name => name.strip)
+        end
+
         #
         # Searches for models with the unique name.
         #

data/lib/ronin/open_port.rb

@@ -18,10 +18,6 @@
 #
 
 require 'ronin/model'
-require 'ronin/ip_address'
-require 'ronin/port'
-require 'ronin/service'
-require 'ronin/service_credential'
 
 require 'dm-timestamps'
 

data/lib/ronin/organization.rb

@@ -20,7 +20,6 @@
 require 'ronin/model'
 require 'ronin/model/has_unique_name'
 require 'ronin/model/has_description'
-require 'ronin/address'
 
 require 'dm-timestamps'
 

data/lib/ronin/os.rb

@@ -19,8 +19,6 @@
 
 require 'ronin/model'
 require 'ronin/model/has_name'
-require 'ronin/os_guess'
-require 'ronin/ip_address'
 require 'ronin/extensions/meta'
 
 require 'dm-is-predefined'

data/lib/ronin/os_guess.rb

@@ -18,8 +18,6 @@
 #
 
 require 'ronin/model'
-require 'ronin/os'
-require 'ronin/ip_address'
 
 require 'dm-timestamps'
 

data/lib/ronin/password.rb

@@ -18,7 +18,6 @@
 #
 
 require 'ronin/model'
-require 'ronin/credential'
 
 require 'digest'
 
@@ -44,6 +43,23 @@ module Ronin
     # The user names which use the password
     has 0..n, :user_names, :through => :credentials
 
+    #
+    # Parses a password.
+    #
+    # @param [#to_s] password
+    #   The password to parse.
+    #
+    # @return [Password]
+    #   The parsed password.
+    #
+    # @since 1.4.0
+    #
+    # @api public
+    #
+    def self.parse(password)
+      first_or_new(:clear_text => password.to_s)
+    end
+
     #
     # Hashes the password.
     #

data/lib/ronin/port.rb

@@ -18,7 +18,6 @@
 #
 
 require 'ronin/model'
-require 'ronin/open_port'
 
 module Ronin
   #
@@ -47,6 +46,40 @@ module Ronin
 
     validates_uniqueness_of :number, :scope => [:protocol]
 
+    #
+    # Creates a new Port.
+    #
+    # @param [String, Integer] number
+    #   The port number.
+    #
+    # @return [Port]
+    #   The new or previously saved port.
+    #
+    # @since 1.4.0
+    #
+    # @api public
+    #
+    def self.from(number)
+      first_or_new(:number => number)
+    end
+
+    #
+    # Parses a port number.
+    #
+    # @param [String, Integer] number
+    #   The port number to parse.
+    #
+    # @return [Port]
+    #   The parsed port.
+    #
+    # @since 1.4.0
+    #
+    # @api public
+    #
+    def self.parse(number)
+      from(number.to_i)
+    end
+
     #
     # Converts the port to an integer.
     #

data/lib/ronin/repository.rb

@@ -19,7 +19,9 @@
 
 require 'ronin/exceptions/duplicate_repository'
 require 'ronin/exceptions/repository_not_found'
-require 'ronin/script/path'
+require 'ronin/model/has_name'
+require 'ronin/model/has_title'
+require 'ronin/model/has_description'
 require 'ronin/model/has_license'
 require 'ronin/model/has_authors'
 require 'ronin/model'
@@ -39,6 +41,9 @@ module Ronin
   class Repository
 
     include Model
+    include Model::HasName
+    include Model::HasTitle
+    include Model::HasDescription
     include Model::HasAuthors
     include Model::HasLicense
     include DataPaths
@@ -81,7 +86,7 @@ module Ronin
     property :installed, Boolean, :default => false
 
     # Name of the repository
-    property :name, String, :default => lambda { |repo,name|
+    property :name, String, :default => proc { |repo,name|
       repo.path.basename
     }
 
@@ -146,15 +151,15 @@ module Ronin
     def initialize(attributes={})
       super(attributes)
 
-      @bin_dir = self.path.join(BIN_DIR)
-      @lib_dir = self.path.join(LIB_DIR)
-      @data_dir = self.path.join(DATA_DIR)
+      @bin_dir     = self.path.join(BIN_DIR)
+      @lib_dir     = self.path.join(LIB_DIR)
+      @data_dir    = self.path.join(DATA_DIR)
       @script_dirs = SCRIPT_DIRS.map { |dir| self.path.join(dir) }
 
-      @activated = false
-
       initialize_metadata
 
+      @activated = false
+
       yield self if block_given?
     end
 
@@ -217,7 +222,7 @@ module Ronin
     #
     # @api private
     #
-    def Repository.add!(options={})
+    def Repository.add(options={})
       unless options.has_key?(:path)
         raise(ArgumentError,"the :path option was not given")
       end
@@ -234,9 +239,9 @@ module Ronin
 
       # create the repository
       repo = Repository.new(options.merge(
-        :path => path,
+        :path      => path,
         :installed => false,
-        :domain => LOCAL_DOMAIN
+        :domain    => LOCAL_DOMAIN
       ))
 
       if Repository.count(:name => repo.name, :domain => repo.domain) > 0
@@ -284,13 +289,14 @@ module Ronin
     #
     # @api private
     #
-    def Repository.install!(options={})
+    def Repository.install(options={})
       unless options[:uri]
         raise(ArgumentError,":uri must be passed to Repository.install")
       end
 
       remote_repo = Pullr::RemoteRepository.new(options)
-      name = remote_repo.name
+
+      name   = remote_repo.name
       domain = if remote_repo.uri.scheme
                  remote_repo.uri.host
                else
@@ -310,12 +316,12 @@ module Ronin
 
       # add the new remote repository
       repo = Repository.new(
-        :path => path,
-        :scm => local_repo.scm,
-        :uri => remote_repo.uri,
+        :path      => path,
+        :scm       => local_repo.scm,
+        :uri       => remote_repo.uri,
         :installed => true,
-        :name => name,
-        :domain => domain
+        :name      => name,
+        :domain    => domain
       )
 
       # save the repository 
@@ -359,14 +365,14 @@ module Ronin
     # @return [nil]
     #
     # @example Uninstall the repository with the given name
-    #   Repository.uninstall!('postmodern-repo')
+    #   Repository.uninstall('postmodern-repo')
     #
     # @example Uninstall the repository with the given name and domain.
-    #   Repository.uninstall!('postmodern-repo/github.com')
+    #   Repository.uninstall('postmodern-repo/github.com')
     #
     # @api private
     #
-    def Repository.uninstall!(name)
+    def Repository.uninstall(name)
       Repository.find(name).uninstall!
     end
 
@@ -600,7 +606,6 @@ module Ronin
 
       # deactivates the repository
       deactivate!
-
       return self
     end
 
@@ -615,6 +620,7 @@ module Ronin
     # @api private
     #
     def clean_scripts!
+      self.script_paths.destroy
       self.script_paths.clear
       return self
     end
@@ -640,7 +646,7 @@ module Ronin
     def update!
       local_repo = Pullr::LocalRepository.new(
         :path => self.path,
-        :scm => self.scm
+        :scm  => self.scm
       )
 
       # only update if we have a repository
@@ -711,11 +717,11 @@ module Ronin
     def initialize_metadata
       metadata_path = self.path.join(METADATA_FILE)
 
-      self.title = self.name
+      self.title       = self.name
       self.description = nil
-      self.license = nil
+      self.license     = nil
 
-      self.source = self.uri
+      self.source  = self.uri
       self.website = self.source
       self.authors.clear
 

data/lib/ronin/script/buildable.rb

@@ -18,6 +18,7 @@
 #
 
 require 'ronin/script/exceptions/not_built'
+require 'ronin/script/exceptions/build_failed'
 require 'ronin/script/testable'
 require 'ronin/ui/output/helpers'
 
@@ -80,15 +81,15 @@ module Ronin
       #
       def build!(options={})
         self.params = options
-        print_debug "#{script_type} #{self} parameters: #{self.params.inspect}"
+        print_debug "#{self.class.short_name} #{self} parameters: #{self.params.inspect}"
 
-        print_info "Building #{script_type} #{self} ..."
+        print_info "Building #{self.class.short_name} #{self} ..."
 
         @built = false
         @build_blocks.each { |block| block.call() }
         @built = true
 
-        print_info "#{script_type} #{self} built!"
+        print_info "#{self.class.short_name} #{self} built!"
 
         yield if block_given?
         return self
@@ -111,7 +112,7 @@ module Ronin
       #
       def test!
         unless built?
-          raise(NotBuilt,"cannot verify an unbuilt #{script_type}")
+          raise(NotBuilt,"cannot verify an unbuilt #{self.class.short_name}")
         end
 
         super
@@ -119,6 +120,20 @@ module Ronin
 
       protected
 
+      #
+      # Indicates the build has failed.
+      #
+      # @raise [BuildFailed]
+      #   The building of the script failed.
+      #
+      # @since 1.4.0
+      #
+      # @api public
+      #
+      def build_failed!(message)
+        raise(BuildFailed,message)
+      end
+
       #
       # Registers a given block to be called when the script is built.
       #

data/lib/ronin/script/deployable.rb

@@ -67,8 +67,7 @@ module Ronin
       end
 
       #
-      # Tests and then deploys the exploit. If a payload has been set,
-      # the payload will also be deployed.
+      # Tests and then deploys the script.
       #
       # @yield []
       #   If a block is given, it will be passed the deployed script
@@ -86,14 +85,14 @@ module Ronin
       def deploy!
         test!
 
-        print_info "Deploying #{script_type} #{self} ..."
+        print_info "Deploying #{self.class.short_name} #{self} ..."
 
         @deployed = false
         @deploy_blocks.each { |block| block.call() }
         @deployed = true
         @evacuated = false
 
-        print_info "#{script_type} #{self} deployed!"
+        print_info "#{self.class.short_name} #{self} deployed!"
 
         yield if block_given?
         return self
@@ -132,24 +131,24 @@ module Ronin
       def evacuate!
         yield if block_given?
 
-        print_info "Evauating #{script_type} #{self} ..."
+        print_info "Evauating #{self.class.short_name} #{self} ..."
 
         @evacuated = false
         @evacuate_blocks.each { |block| block.call() }
         @evacuated = true
         @deployed = false
 
-        print_info "#{script_type} #{self} evacuated."
+        print_info "#{self.class.short_name} #{self} evacuated."
         return self
       end
 
       protected
 
       #
-      # Indicates the deployment of the exploit has failed.
+      # Indicates the deployment of the script has failed.
       #
       # @raise [DeployFailed]
-      #   The deployment of the exploit failed.
+      #   The deployment of the script failed.
       #
       # @since 1.1.0
       #