boris 1.0.0.beta.1 → 1.0.1

data/lib/boris/options.rb

@@ -1,23 +1,31 @@
+require 'boris/profiler'
+
+require 'boris/profilers/linux/redhat'
+require 'boris/profilers/unix/solaris'
+require 'boris/profilers/windows/windows2003'
+require 'boris/profilers/windows/windows2008'
+require 'boris/profilers/windows/windows2012'
+
 module Boris
   class Options
+    include Lumberjack
+
     attr_accessor :options
 
     # Creates our options hash where the user can pass in an optional hash to immediately
     # override the default values.
     #
-    #  credentials = [{:user=>'joe', :password=>'mypassword', :connection_types=>[:ssh, :wmi]}]
+    #  credentials = [{:user=>'myuser', :password=>'mypassword', :connection_types=>[:ssh, :wmi]}]
     #  ssh_keys = ['/home/joe/private_key']
-    #  options = Boris::Options.new(:log_level=>:debug, :ssh_options=>{:keys=>ssh_keys}, :credentials=>credentials)
+    #  options = Boris::Options.new(:log_level=>:debug, :credentials=>credentials, :ssh_options=>{:keys=>ssh_keys})
     #
     # @option options [Boolean] :auto_scrub_data should the target's data be scrubbed
     #  after running #retrieve_all?
     # @option options [Array] :credentials an array of credentials in the format of
     #  +:user+, +:password+, +:connection_types+.  Only +:user+ is mandatory.
-    # @option options [Symbol] :log_level The level of logging.  Options are:
-    #  +:debug+, +:info+, +:warn+, +:error+, +:fatal (default)+
-    # @option options [Array] profiles An array of module names of the profiles we wish
-    #  to have available for use on this target.  {Boris::Profiles::RedHat} and
-    #  {Profiles::Solaris} are always the defaults, and Windows profiles are included
+    # @option options [Array] profilers An array of module names of the profilers we wish
+    #  to have available for use on this target.  {Boris::Profilers::RedHat} and
+    #  {Profilers::Solaris} are always the defaults, and Windows profilers are included
     #  as defaults as well if {Boris} is running on a Windows host (where WMI connections
     #  are available)
     # @option options [Hash] snmp_options A hash of options supported by ruby-snmp.
@@ -25,14 +33,14 @@ module Boris
     #
     # @raise ArgumentError when invalid arguments are passed
     def initialize(options={})
+      @logger = Boris.logger
       @options = {}
 
       # set our defaults
       @options[:auto_scrub_data] ||= true
       @options[:credentials] ||= []
-      @options[:log_level] ||= :fatal
-      @options[:profiles] ||= [Profiles::RedHat, Profiles::Solaris]
-      @options[:profiles].concat([Profiles::Windows::Windows2003, Profiles::Windows::Windows2008, Profiles::Windows::Windows2012]) if PLATFORM == :win32
+      @options[:profilers] ||= [Profilers::RedHat, Profilers::Solaris]
+      @options[:profilers].concat([Profilers::Windows2003, Profilers::Windows2008, Profilers::Windows2012]) if PLATFORM == :win32
       @options[:snmp_options] ||= {}
       @options[:ssh_options] ||= {}
 
@@ -46,7 +54,7 @@ module Boris
     end
 
     # Getter method for grabbing a value from the Options.
-    #  puts options[:log_level] #=> :debug
+    #  puts options[:profilers] #=> [Profilers::RedHat]
     #
     # @param key symbol of the key-value pair
     # @return returns the value of specified key from Options
@@ -55,19 +63,23 @@ module Boris
     end
 
     # Setter method for setting the value in the options hash
-    #  puts options[:log_level] #=> :debug
-    #  options[:log_level] = :info
-    #  puts options[:log_level] #=> :info
+    #  puts options[:profilers] #=> [Profilers::RedHat]
+    #  options[:profilers] << Profilers::Solaris
+    #  puts options[:profilers] #=> [Profilers::RedHat, Profilers::Solaris]
     # @raise ArgumentError when invalid options are provided
     def []=(key, val)
       raise ArgumentError, 'invalid option provided' if !@options.has_key?(key)
       @options[key] = val
     end
 
-    # Provides a simple mechanism for adding credentials to the credentials array of Options.
+    # Provides a simple mechanism for adding credentials to the credentials array of Options. The connection types
+    # provided here tell Boris which connection methods this credential should be used for.  If no connection types
+    # are provided, Boris will try to connect using all available connection types with this credential.
+    #
+    #  @target.options.add_credential({:user=>'myuser', :password=>'mypassword', :connection_types=>[:ssh, :wmi]})
     #
     # @param cred [Hash] a credential hash. Values include +:user+, +:password+, and
-    #  +:connection_types+. +:user+ is mandatory, and +:connection_types+ should be an Array.
+    #   +:connection_types+. +:user+ is mandatory, and +:connection_types+ should be an Array.
     # @raise ArgumentError when invalid credentials or connection_types are supplied
     def add_credential(cred)
       raise ArgumentError, 'invalid credential supplied (must be Hash)' if !cred.kind_of?(Hash)

data/lib/boris/profiler.rb

@@ -0,0 +1,19 @@
+require 'boris/structure'
+
+require 'boris/helpers/array'
+require 'boris/helpers/hash'
+require 'boris/helpers/string'
+require 'boris/helpers/scrubber'
+
+module Boris; module Profilers
+  class Profiler
+    include Lumberjack
+    include Structure
+
+    def initialize(connector)
+      @host = connector.host
+      @logger = Boris.logger
+      @connector = connector
+    end
+  end
+end; end

data/lib/boris/profilers/linux/redhat.rb

@@ -0,0 +1,74 @@
+require 'boris/profiler'
+require 'boris/profilers/linux_core'
+
+module Boris; module Profilers
+  class RedHat < Linux
+    
+    def self.matches_target?(connector)
+      release_data = connector.values_at(%q{ls -d /etc/[A-Za-z]*[_-][rv]e[lr]* | grep -v "lsb|system" | cut -d '/' -f3 | cut -d '-' -f1 | cut -d '_' -f1}).join(' ')
+      return true if release_data =~ /redhat/i
+    end
+
+    def get_file_systems; super; end
+    def get_hardware; super; end
+    def get_hosted_shares; super; end
+
+    def get_installed_applications
+      super
+      
+      application_data = @connector.values_at('rpm -qa --queryformat "%{NAME}|%{VERSION}|%{VENDOR}|%{ARCH}|%{INSTALLTIME:date}\n" | sort')
+
+      application_data.each do |application|
+        application = application.split('|')
+        h = installed_application_template
+
+        h[:date_installed] = DateTime.parse(application[4])
+        h[:install_location] = nil
+        h[:name] = application[0]
+        h[:vendor] = application[2]
+        h[:version] = application[1]
+
+        @installed_applications << h
+      end
+
+      @installed_applications
+    end
+
+    def get_installed_patches; super; end
+
+    def get_installed_services
+      super
+      service_data = @connector.values_at("/sbin/chkconfig --list | awk {'print $1'}")
+
+      service_data.each do |service|
+        h = installed_service_template
+        h[:name] = service
+
+        @installed_services << h
+      end
+
+      @installed_services
+    end
+
+    def get_local_user_groups; super; end
+    def get_network_id; super; end
+    def get_network_interfaces; super; end
+
+    def get_operating_system
+      super
+
+      os_install_date = @connector.value_at("rpm -qa basesystem --queryformat '%{INSTALLTIME:date}\n'")
+      kernel_version = @connector.value_at('uname -r')
+      os_data = @connector.values_at('lsb_release -a | egrep -i "description|release"')
+
+      @operating_system[:date_installed] = DateTime.parse(os_install_date)
+      @operating_system[:kernel] = kernel_version
+
+      os_base_name = os_data.grep(/^description/i)[0].after_colon
+      @operating_system[:name] = os_base_name.split(/ linux /i)[0] + ' Linux'
+      @operating_system[:version] = os_base_name.scan(/linux (.*) release/i).join + ' ' + os_data.grep(/^release/i)[0].after_colon
+
+      @operating_system
+    end
+  end
+end; end

data/lib/boris/{profiles → profilers}/linux_core.rb

@@ -1,8 +1,7 @@
-require 'boris/structure'
+require 'boris/profiler'
 
-module Boris; module Profiles
-  module Linux
-    include Structure
+module Boris; module Profilers
+  class Linux < Profiler
 
     def self.connection_type
       Boris::SSHConnector
@@ -27,6 +26,8 @@ module Boris; module Profiles
 
         @file_systems << h
       end
+
+      @file_systems
     end
 
     def get_hardware
@@ -59,6 +60,8 @@ module Boris; module Profiles
       else
         info 'no hardware information available (give me sudo access for dmidecode!)'
       end
+
+      @hardware
     end
 
     def get_hosted_shares; super; end
@@ -92,6 +95,8 @@ module Boris; module Profiles
         
         @local_user_groups << h
       end
+
+      @local_user_groups
     end
 
     def get_network_id
@@ -104,6 +109,8 @@ module Boris; module Profiles
       domain = nil if domain =~ /\(none\)/i
 
       @network_id[:domain] = domain.nil? ? hostname.join('.') : domain
+
+      @network_id
     end
 
     def get_network_interfaces
@@ -209,6 +216,8 @@ module Boris; module Profiles
           @network_interfaces << h
         end
       end
+
+      @network_interfaces
     end
 
     def get_operating_system; super; end

data/lib/boris/{profiles → profilers}/unix/solaris.rb

@@ -1,14 +1,11 @@
-require 'boris/profiles/unix_core'
+require 'boris/profiler'
+require 'boris/profilers/unix_core'
+require 'boris/helpers/constants'
 
-module Boris; module Profiles
-  module Solaris
-    include UNIX
+module Boris; module Profilers
+  class Solaris < UNIX
     
     SOLARIS_ZONE_MODEL = 'Oracle Virtual Platform'
-
-    def self.connection_type
-      UNIX.connection_type
-    end
     
     def self.matches_target?(connector)
       return true if connector.value_at('uname') =~ /sunos/i
@@ -55,6 +52,8 @@ module Boris; module Profiles
       else
         cpu_data.grep(/vendor_id/i)[0].after_pipe
       end
+
+      @hardware
     end
 
     def get_hosted_shares
@@ -68,23 +67,24 @@ module Boris; module Profiles
         h[:path] = share[1]
         @hosted_shares << h
       end
+
+      @hosted_shares
     end
 
     def get_installed_applications
       super
 
       application_data = @connector.values_at("pkginfo -il -c application | egrep -i '^$|(name|version|basedir|vendor|instdate):'")
-      application_data.join("\n").split("\n\n").each do |application|
-
-        application = application.split("\n")
+      application_data.join("\n").split(/\n\n/).each do |application|
+        application = application.split(/\n/)
         h = installed_application_template
 
-        date_installed = application.grep(/instdate:/i)[0].split(/instdate:/i)[1].strip
-        h[:date_installed] = DateTime.strptime(date_installed, '%b %d %Y %H:%M')
         h[:name] = application.grep(/name:/i)[0].after_colon
         h[:version] = application.grep(/version:/i)[0].after_colon
 
-        # these sometimes don't show up
+        # these items sometimes don't show up
+        date_installed = application.grep(/instdate:/i)[0]
+        h[:date_installed] = DateTime.strptime(date_installed.split(/instdate:/i)[1].strip, '%b %d %Y %H:%M') if date_installed
         install_location = application.grep(/basedir:/i)[0]
         h[:install_location] = install_location.after_colon if install_location
         vendor = application.grep(/vendor:/i)[0]
@@ -92,6 +92,8 @@ module Boris; module Profiles
 
         @installed_applications << h
       end
+
+      @installed_applications
     end
 
     def get_installed_patches
@@ -113,6 +115,8 @@ module Boris; module Profiles
 
         @installed_patches << h
       end
+
+      @installed_patches
     end
 
     def get_installed_services
@@ -125,6 +129,8 @@ module Boris; module Profiles
 
         @installed_services << h
       end
+
+      @installed_services
     end
 
     def get_local_user_groups; super; end
@@ -186,7 +192,7 @@ module Boris; module Profiles
             interface_line = ifconfig_data[0].split
             inet_line = ifconfig_data[1].split
 
-            subnet = inet_line[3] ? inet_line[3].hex_to_address : nil
+            subnet = inet_line[3] ? inet_line[3].hex_to_ip_address : nil
 
             h[:status] = 'up' if interface_line[1] =~ /<up/i
 
@@ -278,6 +284,8 @@ module Boris; module Profiles
         
         @network_interfaces << h
       end
+
+      @network_interfaces
     end
 
     def get_operating_system
@@ -290,6 +298,8 @@ module Boris; module Profiles
       @operating_system[:kernel] = os_data[1]
       @operating_system[:name] = 'Oracle Solaris'
       @operating_system[:version] = os_data[0]
+
+      @operating_system
     end
 
     private

data/lib/boris/{profiles → profilers}/unix_core.rb

@@ -1,85 +1,90 @@
-require 'boris/structure'
-
-module Boris; module Profiles
-  module UNIX
-    include Structure
-
-    def self.connection_type
-      Boris::SSHConnector
-    end
-
-    def self.matches_target?(connector)
-      return true if connector.value_at('uname -a') !~ /linux/i
-    end
-
-    def get_file_systems
-      super
-
-      file_system_command = %q{df -kl 2>/dev/null | grep ^/ | nawk '{print $1 "|" $2 / 1024 "|" $3 / 1024 "|" $6}'}
-      @connector.values_at(file_system_command).each do |file_system|
-        h = file_system_template
-        file_system = file_system.split('|')
-
-        h[:capacity_mb] = file_system[1].to_i
-        h[:file_system] = file_system[0]
-        h[:mount_point] = file_system[3]
-        h[:used_space_mb] = file_system[2].to_i
-
-        @file_systems << h
-      end
-    end
-
-    def get_hardware; super; end
-    def get_hosted_shares; super; end
-    def get_installed_applications; super; end
-    def get_installed_patches; super; end
-    def get_installed_services; super; end
-
-    def get_local_user_groups
-      super
-
-      user_data = @connector.values_at('cat /etc/passwd | grep -v "^#"')
-      group_data = @connector.values_at('cat /etc/group | grep -v "^#"')
-
-      users = []
-      groups = []
-
-      user_data.each do |x|
-        h = {}
-        x = x.split(':')
-        h[:status] = nil
-        h[:primary_group_id] = x[3]
-        h[:username] = x[0]
-        users << h
-      end
-
-      group_data.each do |group|
-        group = group.split(':')
-        h = {:members=>[], :name=>group[0]}
-
-        h[:members] = users.select{|user| (user[:primary_group_id] == group[2])}.collect{|user| user[:username]}
-        
-        @local_user_groups << h
-      end
-    end
-
-    def get_network_id
-      super
-
-      hostname = @connector.value_at('hostname')
-      domain = @connector.value_at('domainname')
-      domain = nil if domain =~ /\(none\)/i
-      
-      if hostname =~ /\./
-        hostname = hostname.split('.').shift
-        domain = hostname.join('.') if hostname =~ /\./
-      end
-
-      @network_id[:hostname] = hostname
-      @network_id[:domain] = domain
-    end
-
-    def get_network_interfaces; super; end
-    def get_operating_system; super; end
-  end
-end; end
+require 'boris/profiler'
+
+module Boris; module Profilers
+  class UNIX < Profiler
+
+    def self.connection_type
+      Boris::SSHConnector
+    end
+
+    def self.matches_target?(connector)
+      return true if connector.value_at('uname -a') !~ /linux/i
+    end
+
+    def get_file_systems
+      super
+
+      file_system_command = %q{df -kl 2>/dev/null | grep ^/ | nawk '{print $1 "|" $2 / 1024 "|" $3 / 1024 "|" $6}'}
+      @connector.values_at(file_system_command).each do |file_system|
+        h = file_system_template
+        file_system = file_system.split('|')
+
+        h[:capacity_mb] = file_system[1].to_i
+        h[:file_system] = file_system[0]
+        h[:mount_point] = file_system[3]
+        h[:used_space_mb] = file_system[2].to_i
+
+        @file_systems << h
+      end
+
+      @file_systems
+    end
+
+    def get_hardware; super; end
+    def get_hosted_shares; super; end
+    def get_installed_applications; super; end
+    def get_installed_patches; super; end
+    def get_installed_services; super; end
+
+    def get_local_user_groups
+      super
+
+      user_data = @connector.values_at('cat /etc/passwd | grep -v "^#"')
+      group_data = @connector.values_at('cat /etc/group | grep -v "^#"')
+
+      users = []
+      groups = []
+
+      user_data.each do |x|
+        h = {}
+        x = x.split(':')
+        h[:status] = nil
+        h[:primary_group_id] = x[3]
+        h[:username] = x[0]
+        users << h
+      end
+
+      group_data.each do |group|
+        group = group.split(':')
+        h = {:members=>[], :name=>group[0]}
+
+        h[:members] = users.select{|user| (user[:primary_group_id] == group[2])}.collect{|user| user[:username]}
+        
+        @local_user_groups << h
+      end
+
+      @local_user_groups
+    end
+
+    def get_network_id
+      super
+
+      hostname = @connector.value_at('hostname')
+      domain = @connector.value_at('domainname')
+      domain = nil if domain =~ /\(none\)/i
+      
+      if hostname =~ /\./
+        hostname = hostname.split('.').shift
+        domain = hostname.join('.') if hostname =~ /\./
+      end
+
+      @network_id[:hostname] = hostname
+      @network_id[:domain] = domain
+
+      @network_id
+    end
+
+    def get_network_interfaces; super; end
+    def get_operating_system; super; end
+  end
+end; end