ronin 0.3.0 → 1.0.0.pre1

data/lib/ronin/cached_file.rb

@@ -0,0 +1,249 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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/support/inflector'
+require 'ronin/repository'
+require 'ronin/model'
+
+require 'contextify'
+
+module Ronin
+  #
+  # The {CachedFile} model stores information in the {Database} about
+  # files that {Cacheable} Models were cached from. {CachedFile} also
+  # manages the {Cacheable} objects that were saved in the {Database}.
+  #
+  class CachedFile
+
+    include Model
+
+    # The primary key of the cached file
+    property :id, Serial
+
+    # The path to the file where the object was defined in
+    property :path, FilePath, :required => true
+
+    # The timestamp of the cached file
+    property :timestamp, Time, :required => true
+
+    # The class name of the cached object
+    property :model_name, String, :required => true
+
+    # The repository the file was cached from
+    belongs_to :repository
+
+    # Any exceptions raise when loading a fresh object
+    attr_reader :cache_exception
+
+    # Any cache errors encountered when caching the object
+    attr_reader :cache_errors
+
+    #
+    # The path to require to access the Class of the cached object.
+    #
+    # @return [String]
+    #   The possible path infered from the class name.
+    #
+    def model_path
+      if self.model_name
+        return self.model_name.underscore
+      end
+    end
+
+    #
+    # The Model of the cached object.
+    #
+    # @return [Class, nil]
+    #   Returns the Model of the cached object, or `nil` if the class
+    #   could not be loaded or found.
+    #
+    def cached_model
+      return unless self.model_name
+
+      # filter out unloadable models
+      begin
+        require model_path
+      rescue Gem::LoadError => e
+        raise(e)
+      rescue ::LoadError
+      end
+
+      # filter out missing class names
+      model = begin
+                ::Object.full_const_get(self.model_name)
+              rescue NameError
+                return nil
+              end
+
+      # filter out non-Cacheable models
+      return model if model.ancestors.include?(Cacheable)
+    end
+
+    #
+    # The object from the Database that was cached from the file.
+    #
+    # @return [Model]
+    #   The previously cached object connected to the cache file.
+    #
+    def cached_object
+      if (model = self.cached_model)
+        return model.first(:cached_file => self)
+      end
+    end
+
+    #
+    # A freshly loaded Cacheable object from the cache file.
+    #
+    # @return [Cacheable, nil]
+    #   The first Cacheable object loaded from the cache file.
+    #   If `nil` is returned, the file did not contain any cacheable
+    #   objects or the cache file contained a syntax error.
+    #   
+    def fresh_object
+      begin
+        # load the first found context
+        blocks = Contextify.load_blocks(self.path)
+      rescue Exception => e
+        @cache_exception = e
+        return nil
+      end
+
+      blocks.each do |name,block|
+        model = Contextify.contexts[name]
+
+        if model.ancestors.include?(Cacheable)
+          # create the fresh object
+          object = model.new()
+
+          begin
+            object.instance_eval(&block)
+
+            @cache_exception = nil
+            return object
+          rescue Exception => e
+            @cache_exception = e
+          end
+        end
+      end
+
+      return nil
+    end
+
+    #
+    # Determines if the cache file was updated.
+    #
+    # @return [Boolean]
+    #   Specifies whether the cache file was updated.
+    #
+    def updated?
+      # assume updates if there is no timestamp
+      return true unless self.timestamp
+
+      if File.file?(self.path)
+        return self.path.mtime > self.timestamp
+      end
+
+      # do not assume updates, if there is no path
+      return false
+    end
+
+    #
+    # Determines if the cache file was deleted.
+    #
+    # @return [Boolean]
+    #   Specifies whether the cache file was deleted.
+    #
+    def missing?
+      !(self.path.file?)
+    end
+
+    #
+    # Caches the freshly loaded object from the cache file into the
+    # Database.
+    #
+    # @return [Boolean]
+    #   Specifies whether the object was successfully cached.
+    #
+    def cache
+      if (obj = fresh_object)
+        # reset the model-class
+        self.model_name = obj.class.to_s
+
+        # update the timestamp
+        self.timestamp = self.path.mtime
+
+        # re-cache the fresh_object
+        obj.cached_file = self
+
+        if obj.save
+          @cache_errors = nil
+          return true
+        else
+          @cache_errors = obj.errors
+        end
+      end
+
+      return false
+    end
+
+    #
+    # Syncs the cached object in the Database with the object loaded from
+    # the cache file.
+    #
+    # @return [Boolean]
+    #   Specifies whether the cached object was successfully synced.
+    #
+    def sync
+      if missing?
+        # destroy the cached file, if the actual file is missing
+        return destroy
+      elsif updated?
+        if (obj = cached_object)
+          # destroy the previously cached object
+          obj.destroy!
+        end
+
+        unless cache
+          # if we couldn't cache anything, self-destruct
+          destroy
+        end
+
+        return true
+      end
+
+      return false
+    end
+
+    #
+    # Before destroying the cached file object, also destroy the
+    # associated cached object.
+    #
+    def destroy
+      unless destroyed?
+        if (obj = self.cached_object)
+          obj.destroy!
+        end
+      end
+
+      super
+    end
+
+  end
+end

data/lib/ronin/campaign.rb

@@ -0,0 +1,130 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2009-2010 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/model'
+require 'ronin/model/has_name'
+require 'ronin/model/has_description'
+require 'ronin/config'
+require 'ronin/target'
+
+require 'fileutils'
+
+module Ronin
+  class Campaign
+
+    include Model
+    include Model::HasName
+    include Model::HasDescription
+
+    # Primary key of the campaign
+    property :id, Serial
+
+    # The targets of the campaign
+    has 0..n, :targets
+
+    # The addresses being targeted in the campaign
+    has 0..n, :addresses, :through => :targets
+
+    # The organization the campaign covers
+    has 0..n, :organizations, :through => :targets
+
+    #
+    # Searches for all campaigns targeting an {Address}.
+    #
+    # @param [Array<String>, String] addr
+    #   The address(es) to search for.
+    #
+    # @return [Array<Campaign>]
+    #   The campaigns that target the given address.
+    #
+    # @since 1.0.0
+    #
+    def self.targeting(addr)
+      all('addresses.address' => addr)
+    end
+
+    #
+    # Determines if an address is targeted by the campaign.
+    #
+    # @param [Address] address
+    #   The address.
+    #
+    # @return [Boolean]
+    #   Specifies whether the address is targeted.
+    #
+    # @since 1.0.0
+    #
+    def targets?(addr)
+      self.addresses.include?(address)
+    end
+
+    #
+    # Adds an address to the campaign.
+    #
+    # @param [String] addr
+    #   The address that will be targeted.
+    #
+    # @return [Target]
+    #   The new target of the campaign.
+    #
+    # @raise [RuntimeError]
+    #   The given address could not be found.
+    #
+    # @since 1.0.0
+    #
+    def target!(addr)
+      unless (address = Address.first(:address => addr))
+        raise("unknown address #{addr.dump}")
+      end
+
+      return Target.first_or_create(:campaign => self, :address => address)
+    end
+
+    #
+    # The file-name to use for the campaign.
+    #
+    # @return [String, nil]
+    #   The File System safe name to use for the campaign.
+    #
+    # @since 1.0.0
+    #
+    def filename
+      self.name.downcase.gsub(/[^a-z0-9]+/,'_') if self.name
+    end
+
+    #
+    # The directory to store files related to the campaign.
+    #
+    # @return [String, nil]
+    #   The path to the directory.
+    #
+    # @since 1.0.0
+    #
+    def directory
+      if self.name
+        path = File.join(Config::CAMPAIGNS_DIR,filename)
+
+        FileUtils.mkdir(path) unless File.directory?(path)
+        return path
+      end
+    end
+
+  end
+end

data/lib/ronin/class_methods.rb

@@ -0,0 +1,27 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2006-2010 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
+#
+
+module Ronin
+  module ClassMethods
+    def const_missing(name)
+      Ronin.send(:const_missing,name) || super(name)
+    end
+  end
+end

data/lib/ronin/config.rb

@@ -1,7 +1,7 @@
 #
 # Ronin - A Ruby platform for exploit development and security research.
 #
-# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2010 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
@@ -18,46 +18,52 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
+require 'data_paths'
 require 'fileutils'
 
 module Ronin
   module Config
+    include DataPaths
+
     # The users home directory
     HOME = File.expand_path(ENV['HOME'] || ENV['HOMEPATH'])
 
     # Ronin home directory
-    PATH = FileUtils.mkdir_p(File.join(HOME,'.ronin'))
-
-    # Main configuration file
-    CONFIG_PATH = File.join(PATH,'config.rb')
+    PATH = File.join(HOME,'.ronin')
 
     # Configuration files directory
-    CONFIG_DIR = FileUtils.mkdir_p(File.join(PATH,'config'))
+    CONFIG_DIR = File.join(PATH,'config')
+
+    # Directory which repositories are installed into
+    REPOS_DIR = File.join(PATH,'repos')
 
     # Temporary file directory
-    TMP_DIR = FileUtils.mkdir_p(File.join(PATH,'tmp'))
+    TMP_DIR = File.join(PATH,'tmp')
+
+    # Directory for storing files for campaigns
+    CAMPAIGNS_DIR = File.join(PATH,'campaigns')
+    
+    FileUtils.mkdir(PATH) unless File.directory?(PATH)
+    FileUtils.mkdir(CONFIG_DIR) unless File.directory?(PATH)
+    FileUtils.mkdir(TMP_DIR) unless File.directory?(TMP_DIR)
+    FileUtils.mkdir(CAMPAIGNS_DIR) unless File.directory?(CAMPAIGNS_DIR)
 
     #
     # Loads the Ronin configuration file.
     #
-    # @param [String, nil] name
+    # @param [Symbol, String, nil] name
     #   The optional name of the file to load within +CONFIG_DIR+.
-    #   If no name is given, +CONFIG_PATH+ will simply be loaded.
     #
-    # @example Load the main config file at <tt>~/.ronin/config.rb</tt>
+    # @example Load the config file at `~/.ronin/config/ronin.rb`
     #   Config.load
     #   # => true
     #
-    # @example Load a specific config file in <tt>~/.ronin/config/</tt>
+    # @example Load a specific config file in `~/.ronin/config/`
     #   Config.load :sql
     #   # => true
     #
-    def Config.load(name=nil)
-      if name
-        path = File.expand_path(File.join(CONFIG_DIR,name.to_s))
-      else
-        path = CONFIG_PATH
-      end
+    def Config.load(name=:ronin)
+      path = File.expand_path(File.join(CONFIG_DIR,name.to_s))
 
       require path if File.file?(path)
     end

data/lib/ronin/credential.rb

@@ -0,0 +1,114 @@
+#
+# Ronin - A Ruby platform for exploit development and security research.
+#
+# Copyright (c) 2009-2010 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/user_name'
+require 'ronin/password'
+require 'ronin/model'
+
+module Ronin
+  class Credential
+
+    include Model
+
+    # Primary key of the credential
+    property :id, Serial
+
+    # Password of the credential
+    belongs_to :password
+
+    # User name of the credential
+    belongs_to :user_name
+
+    #
+    # Searches for all credentials for a specific user.
+    #
+    # @param [String] name
+    #   The name of the user.
+    #
+    # @return [Array<Credential>]
+    #   The credentials for the user.
+    #
+    # @since 1.0.0
+    #
+    def self.for_user(name)
+      all('user_name.name' => name)
+    end
+
+    #
+    # Searches for all credentials with a common password.
+    #
+    # @param [String] password
+    #   The password to search for.
+    #
+    # @return [Array<Credential>]
+    #   The credentials with the common password.
+    #
+    # @since 1.0.0
+    #
+    def self.with_password(password)
+      all('password.clear_text' => password)
+    end
+
+    #
+    # The user the credential belongs to.
+    #
+    # @return [String]
+    #   The user name.
+    #
+    # @since 1.0.0
+    #
+    def user
+      self.user_name.name if self.user_name
+    end
+
+    #
+    # Converts the credentials to a String.
+    #
+    # @return [String]
+    #   The user name and the password.
+    #
+    # @since 1.0.0
+    #
+    def to_s
+      "#{self.user_name}:#{self.password}"
+    end
+
+    #
+    # Splits the credential to multiple variables.
+    #
+    # @return [Array<String>]
+    #   The user and the password.
+    #
+    # @example
+    #   user, password = cred
+    #
+    #   user
+    #   # => "alice"
+    #   password
+    #   # => "secret"
+    #
+    # @since 1.0.0
+    #
+    def to_ary
+      [self.user.name, self.password.clear_text]
+    end
+
+  end
+end