ronin 1.0.0 → 1.1.0.rc1

data/lib/ronin/email_address.rb

@@ -18,13 +18,12 @@
 #
 
 require 'ronin/model'
+require 'ronin/user_name'
+require 'ronin/host_name'
 
 require 'dm-timestamps'
 
 module Ronin
-  autoload :UserName, 'ronin/user_name'
-  autoload :HostName, 'ronin/host_name'
-
   #
   # Represents email addresses that can be stored in the {Database}.
   #
@@ -65,6 +64,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_hosts(names)
       all(:host_name => {:address => names})
     end
@@ -80,6 +81,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_ips(ips)
       all(:ip_addresses => {:address => ips})
     end
@@ -95,6 +98,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_users(names)
       all(:user_name => {:name => names})
     end
@@ -113,6 +118,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def EmailAddress.parse(email)
       user, host = email.split('@',2)
 
@@ -142,6 +149,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def user
       self.user_name.name if self.user_name
     end
@@ -154,6 +163,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def host
       self.host_name.address if self.host_name
     end
@@ -166,6 +177,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_s
       "#{self.user_name}@#{self.host_name}"
     end
@@ -178,6 +191,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def inspect
       "#<#{self.class}: #{self}>"
     end
@@ -199,6 +214,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_ary
       [self.user_name.name, self.host_name.address]
     end

data/lib/ronin/environment.rb

@@ -26,9 +26,6 @@ require 'ronin/formatting/extensions'
 require 'ronin/network/extensions'
 require 'ronin/ui/output/helpers'
 
-require 'chars/extensions'
-require 'hexdump/extensions'
-
 #
 # Includes the Ronin namespace and output helper methods.
 #

data/lib/ronin/host_name.rb

@@ -18,15 +18,13 @@
 #
 
 require 'ronin/address'
-require 'ronin/model'
+require 'ronin/host_name_ip_address'
+require 'ronin/url'
+require 'ronin/email_address'
 
 require 'resolv'
 
 module Ronin
-  autoload :HostNameIPAddress, 'ronin/host_name_ip_address'
-  autoload :URL, 'ronin/url'
-  autoload :EmailAddress, 'ronin/email_address'
-
   #
   # Represents host names that can be stored in the {Database}.
   #
@@ -67,6 +65,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_ips(ips)
       all(:ip_addresses => {:address => ips})
     end
@@ -82,6 +82,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_ports(numbers)
       all(:ports => {:number => numbers})
     end
@@ -97,6 +99,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.tld(name)
       all(:address.like => "%.#{name}")
     end
@@ -112,6 +116,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.domain(name)
       all(:address.like => "#{name}.%") |
       all(:address.like => "%.#{name}.%")
@@ -128,6 +134,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.lookup(addr)
       addr = addr.to_s
       ip = IPAddress.first_or_new(:address => addr)
@@ -157,6 +165,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def lookup!
       ips = begin
               Resolv.getaddresses(self.address)
@@ -182,6 +192,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def recent_ip_address
       self.host_name_ip_addresses.all(
         :order => [:created_at.desc]
@@ -196,9 +208,11 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def last_scanned_at
       last_scanned_url = self.urls.first(
-        :order_by => [:last_scanned_at.desc]
+        :order => [:last_scanned_at.desc]
       )
 
       return last_scanned_url.last_scanned_at if last_scanned_url

data/lib/ronin/host_name_ip_address.rb

@@ -18,13 +18,12 @@
 #
 
 require 'ronin/model'
+require 'ronin/host_name'
+require 'ronin/ip_address'
 
 require 'dm-timestamps'
 
 module Ronin
-  autoload :HostName, 'ronin/host_name'
-  autoload :IPAddress, 'ronin/ip_address'
-
   #
   # Associates a {HostName} with an {IPAddress}.
   #

data/lib/ronin/installation.rb

@@ -17,6 +17,8 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'set'
+
 module Ronin
   #
   # The {Installation} module provides methods which help reflect on the
@@ -25,6 +27,7 @@ module Ronin
   module Installation
     # The loaded gemspecs of all installed ronin libraries
     @gems = {}
+    @paths = Set[]
 
     #
     # Finds the installed Ronin libraries via RubyGems.
@@ -34,11 +37,28 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api semipublic
+    #
     def Installation.gems
-      load_gemspecs! if @gems.empty?
+      load! if @gems.empty?
       return @gems
     end
 
+    #
+    # The paths of the installed Ronin libraries.
+    #
+    # @return [Set<String>]
+    #   The paths of the Ronin libraries.
+    #
+    # @since 1.0.1
+    #
+    # @api semipublic
+    #
+    def Installation.paths
+      load! if @paths.empty?
+      return @paths
+    end
+
     #
     # The names of the additional Ronin libraries installed on the system.
     #
@@ -47,6 +67,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api semipublic
+    #
     def Installation.libraries
       gems.keys
     end
@@ -69,15 +91,16 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api semipublic
+    #
     def Installation.each_file(pattern)
       return enum_for(:each_file,pattern) unless block_given?
 
       # query the installed gems
-      gems.each_value do |gem|
-        gem_root = gem.full_gem_path
-        slice_index = gem_root.length + 1
+      paths.each do |gem_path|
+        slice_index = gem_path.length + 1
 
-        Dir.glob(File.join(gem_root,pattern)) do |path|
+        Dir.glob(File.join(gem_path,pattern)) do |path|
           yield path[slice_index..-1]
         end
       end
@@ -105,6 +128,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api semipublic
+    #
     def Installation.each_file_in(directory,ext=nil)
       return enum_for(:each_file_in,directory,ext) unless block_given?
 
@@ -121,38 +146,82 @@ module Ronin
     protected
 
     #
-    # Loads the gemspecs for any installed Ronin libraries.
+    # Finds the installed Ronin gems.
     #
     # @return [true]
     #   All Ronin libraries were successfully found.
     #
-    # @since 1.0.0
+    # @since 1.0.1
     #
-    def Installation.load_gemspecs!
+    # @api private
+    #
+    def Installation.load_gems!
+      register_gem = lambda { |gem|
+        @gems[gem.name] = gem
+        @paths << gem.full_gem_path
+      }
+
       ronin_gem = Gem.loaded_specs['ronin']
 
-      if ronin_gem
-        @gems['ronin'] = ronin_gem
+      # add the main ronin gem
+      register_gem[ronin_gem]
 
-        ronin_gem.dependent_gems.each do |gems|
-          gem = gems.first
-          @gems[gem.name] = gem
-        end
-      else
-        # if we cannot find an installed ronin gem, search the $LOAD_PATH
-        # for ronin gemspecs and load those
-        $LOAD_PATH.each do |lib_dir|
-          root_dir = File.expand_path(File.join(lib_dir,'..'))
-          gemspec_path = Dir[File.join(root_dir,'ronin*.gemspec')].first
-
-          if gemspec_path
-            gem = Gem::SourceIndex.load_specification(gemspec_path)
+      # add any dependent gems
+      ronin_gem.dependent_gems.each do |gems|
+        register_gem[gems[0]]
+      end
+
+      return true
+    end
+
+    #
+    # Loads the gemspecs of Ronin libraries from the `$LOAD_PATH`.
+    #
+    # @return [true]
+    #   All Ronin gemspecs were successfully found.
+    #
+    # @since 1.0.0
+    #
+    # @api private
+    #
+    def Installation.load_gemspecs!
+      $LOAD_PATH.each do |lib_dir|
+        root_dir = File.expand_path(File.join(lib_dir,'..'))
+        gemspec_path = Dir[File.join(root_dir,'ronin*.gemspec')][0]
+
+        if gemspec_path
+          # switch into the gem directory, before loading the gemspec
+          gem = Dir.chdir(root_dir) do
+            Gem::Specification.load(gemspec_path)
+          end
+
+          # do not add duplicate ronin gems
+          unless @gems.has_key?(gem.name)
             @gems[gem.name] = gem
+            @paths << root_dir
           end
         end
       end
 
       return true
     end
+
+    #
+    # Finds the installed Ronin libraries.
+    #
+    # @return [true]
+    #   All Ronin libraries were successfully found.
+    #
+    # @since 1.0.1
+    #
+    # @api private
+    #
+    def Installation.load!
+      if Gem.loaded_specs.has_key?('ronin')
+        load_gems!
+      else
+        load_gemspecs!
+      end
+    end
   end
 end

data/lib/ronin/ip_address.rb

@@ -17,19 +17,16 @@
 # along with Ronin.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require 'ronin/model'
 require 'ronin/address'
+require 'ronin/ip_address_mac_address'
+require 'ronin/host_name_ip_address'
+require 'ronin/os'
+require 'ronin/open_port'
 
 require 'ipaddr'
 require 'resolv'
 
 module Ronin
-  autoload :IPAddressMACAddress, 'ronin/ip_address_mac_address'
-  autoload :HostNameIPAddress, 'ronin/host_name_ip_address'
-  autoload :OSGuess, 'ronin/os_guess'
-  autoload :OS, 'ronin/os'
-  autoload :OpenPort, 'ronin/open_port'
-
   #
   # Represents IP addresses that can be stored in the {Database}.
   #
@@ -86,6 +83,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.v4
       all(:version => 4)
     end
@@ -98,6 +97,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.v6
       all(:version => 6)
     end
@@ -113,6 +114,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_macs(macs)
       all(:mac_addresses => {:address => macs})
     end
@@ -128,6 +131,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_hosts(names)
       all(:host_names => {:address => names})
     end
@@ -143,6 +148,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.with_ports(numbers)
       all(:ports => {:number => numbers})
     end
@@ -158,6 +165,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def self.lookup(name)
       host = HostName.first_or_new(:address => name)
       ips = begin
@@ -184,6 +193,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def lookup!
       hosts = begin
                 Resolv.getnames(self.address.to_s)
@@ -209,6 +220,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def recent_mac_address
       self.ip_address_mac_addresses.all(
         :order => [:created_at.desc]
@@ -223,6 +236,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def recent_host_name
       self.host_name_ip_addresses.all(
         :order => [:created_at.desc]
@@ -238,6 +253,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def recent_os_guess
       self.os_guesses.all(:order => [:created_at.desc]).oses.first
     end
@@ -250,9 +267,11 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def last_scanned_at
       last_scanned_port = self.open_ports.first(
-        :order_by => [:last_scanned_at.desc]
+        :order => [:last_scanned_at.desc]
       )
 
       return last_scanned_port.last_scanned_at if last_scanned_port
@@ -266,6 +285,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_ip
       self.address
     end
@@ -278,6 +299,8 @@ module Ronin
     #
     # @since 1.0.0
     #
+    # @api public
+    #
     def to_i
       self.address.to_i
     end