Update to metasploit_data_models 0.11.0

[#47979793]

Author: limhoff-r7

Gemfile

@@ -15,7 +15,7 @@ group :db do
 	# Needed for Msf::DbManager
 	gem 'activerecord'
 	# Database models shared between framework and Pro.
-	gem 'metasploit_data_models', '~> 0.7.1'
+	gem 'metasploit_data_models', '~> 0.11.0'
 	# Needed for module caching in Mdm::ModuleDetails
 	gem 'pg', '>= 0.11'
 end

Gemfile.lock

@@ -23,7 +23,7 @@ GEM
     i18n (0.6.1)
     json (1.7.7)
     metaclass (0.0.1)
-    metasploit_data_models (0.7.1)
+    metasploit_data_models (0.11.0)
       activerecord (>= 3.2.13)
       activesupport
       pg
@@ -65,7 +65,7 @@ DEPENDENCIES
   database_cleaner
   factory_girl (>= 4.1.0)
   json
-  metasploit_data_models (~> 0.7.1)
+  metasploit_data_models (~> 0.11.0)
   msgpack
   nokogiri
   pcaprub

Rakefile

@@ -36,6 +36,17 @@ else
 	task :default => :spec
 end
 
+# Require yard before loading metasploit_data_models rake tasks as the yard tasks won't be defined if
+# YARD is not defined when yard.rake is loaded.
+begin
+  require 'yard'
+rescue LoadError
+	puts "yard not in bundle, so can't set up yard tasks.  " \
+	     "To generate documentation ensure to install the development group."
+
+	print_without = true
+end
+
 begin
 	require 'metasploit_data_models'
 rescue LoadError
@@ -58,14 +69,6 @@ else
 	end
 end
 
-begin
-  require 'yard'
-rescue LoadError
-	puts "yard not in bundle, so can't set up yard tasks.  " \
-	     "To generate documentation ensure to install the development group."
-
-	print_without = true
-end
 
 
 if print_without

db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130412175040) do
+ActiveRecord::Schema.define(:version => 20130430162145) do
 
   create_table "api_keys", :force => true do |t|
     t.text     "token"
@@ -135,7 +135,7 @@
 
   create_table "hosts", :force => true do |t|
     t.datetime "created_at"
-    t.string   "address",               :limit => nil
+    t.string   "address",               :limit => nil,                  :null => false
     t.string   "mac"
     t.string   "comm"
     t.string   "name"
@@ -145,7 +145,7 @@
     t.string   "os_sp"
     t.string   "os_lang"
     t.string   "arch"
-    t.integer  "workspace_id"
+    t.integer  "workspace_id",                                          :null => false
     t.datetime "updated_at"
     t.text     "purpose"
     t.string   "info",                  :limit => 65536
@@ -157,14 +157,15 @@
     t.integer  "service_count",                          :default => 0
     t.integer  "host_detail_count",                      :default => 0
     t.integer  "exploit_attempt_count",                  :default => 0
+    t.integer  "cred_count",                             :default => 0
   end
 
-  add_index "hosts", ["address"], :name => "index_hosts_on_address"
   add_index "hosts", ["name"], :name => "index_hosts_on_name"
   add_index "hosts", ["os_flavor"], :name => "index_hosts_on_os_flavor"
   add_index "hosts", ["os_name"], :name => "index_hosts_on_os_name"
   add_index "hosts", ["purpose"], :name => "index_hosts_on_purpose"
   add_index "hosts", ["state"], :name => "index_hosts_on_state"
+  add_index "hosts", ["workspace_id", "address"], :name => "index_hosts_on_workspace_id_and_address", :unique => true
 
   create_table "hosts_tags", :id => false, :force => true do |t|
     t.integer "host_id"

lib/msf/core/db_export.rb

@@ -370,7 +370,7 @@ def create_xml_element(key,value)
 	#   module_detail elements.
 	# @return [void]
 	def extract_module_detail_info(report_file)
-      Mdm:Module::Detail.all.each do |m|
+      Mdm::Module::Detail.all.each do |m|
 			report_file.write("<module_detail>\n")
 			m_id = m.attributes["id"]
 

lib/msf/core/db_manager.rb

@@ -404,14 +404,16 @@ def update_all_module_details
 	# Creates an Mdm::Module::Detail from a module instance.
 	#
 	# @param module_instance [Msf::Module] a metasploit module instance.
+	# @raise [ActiveRecord::RecordInvalid] if Hash from {#module_to_details_hash} is invalid attributes for
+	#   Mdm::Module::Detail.
 	# @return [void]
 	def update_module_details(module_instance)
 		return if not self.migrated
 
 		ActiveRecord::Base.connection_pool.with_connection do
 			info = module_to_details_hash(module_instance)
 			bits = info.delete(:bits) || []
-			module_detail = Mdm::Module::Detail.create(info)
+			module_detail = Mdm::Module::Detail.create!(info)
 
 			bits.each do |args|
 				otype, vals = args
@@ -433,7 +435,7 @@ def update_module_details(module_instance)
 			end
 
 			module_detail.ready = true
-			module_detail.save
+			module_detail.save!
 		end
 	end
 
@@ -665,7 +667,7 @@ def search_modules(search_string)
             union_conditions << Mdm::Module::Detail.arel_table[:mtype].matches_any(formatted_values)
           when 'app'
             formatted_values = value_set.collect { |value|
-              formatted_value = 'active'
+              formatted_value = 'aggressive'
 
               if value == 'client'
                 formatted_value = 'passive'

spec/factories/mdm/module_details.rb

@@ -1,87 +1,9 @@
-FactoryGirl.define do
-	type_directory_by_type = {
-			'auxiliary' => 'auxiliary',
-			'encoder' => 'encoders',
-			'exploit' => 'exploits',
-			'nop' => 'nops',
-			'payload' => 'payloads',
-			'post' => 'posts'
-	}
-
-	sequence :mdm_module_detail_disclosure_date do |n|
-		# @todo https://www.pivotaltracker.com/story/show/48450593
-		Date.today - n
-	end
-
-	sequence :mdm_module_detail_description do |n|
-    "Module Description #{n}"
-	end
-
-	sequence :mdm_module_detail_license do |n|
-		"Module License v#{n}"
-	end
-
-	privileges = [false, true]
-	privilege_count = privileges.length
-
-	sequence :mdm_module_detail_privileged do |n|
-	  privileges[n % privilege_count]
-	end
-
-	sequence :mdm_module_detail_mtime do |n|
-		Time.now.utc - n.seconds
-	end
-
-	types = type_directory_by_type.keys
-	type_count = types.length
-
-	sequence :mdm_module_detail_mtype do |n|
-		types[n % type_count]
-	end
-
-	sequence :mdm_module_detail_name do |n|
-		"Module Name #{n}"
-	end
-
-	sequence :mdm_module_detail_rank do |n|
-		100 * (n % 7)
-	end
-
-	stances = ['active', 'passive']
-	sequence :mdm_module_detail_stance, stances.cycle
-end
-
-modules_pathname = Metasploit::Framework.root.join('modules')
-type_directory_by_type = {
-		'auxiliary' => 'auxiliary',
-    'encoder' => 'encoders',
-    'exploit' => 'exploits',
-    'nop' => 'nops',
-    'payload' => 'payloads',
-    'post' => 'posts'
-}
-
 FactoryGirl.modify do
   factory :mdm_module_detail do
-	  description { generate :mdm_module_detail_description }
-	  disclosure_date { generate :mdm_module_detail_disclosure_date }
-	  license { generate :mdm_module_detail_license }
-	  mtime { generate :mdm_module_detail_mtime }
-	  mtype { generate :mdm_module_detail_mtype }
-	  privileged { generate :mdm_module_detail_privileged }
-	  name { generate :mdm_module_detail_name }
-	  rank { generate :mdm_module_detail_rank }
-	  refname { generate :mdm_module_detail_refname }
-	  fullname { "#{mtype}/#{refname}" }
-	  stance { generate :mdm_module_detail_stance }
-
-	  file {
-		  type_directory = type_directory_by_type[mtype]
-
-		  modules_pathname.join(
-				  type_directory,
-				  "#{refname}.rb"
-		  ).to_path
-	  }
+		ignore do
+			root {
+				Metasploit::Framework.root
+			}
+		end
   end
 end

spec/lib/msf/db_manager_spec.rb

@@ -265,7 +265,7 @@ def purge_all_module_details
 
 						context 'with session responds to arch' do
 							let(:arch) do
-								'Arch'
+								FactoryGirl.generate :mdm_host_arch
 							end
 
 							before(:each) do
@@ -828,7 +828,7 @@ def remove_module_details
 			end
 
 			before(:each) do
-				['active', 'passive'].each do |stance|
+				Mdm::Module::Detail::STANCES.each do |stance|
 					FactoryGirl.create(:mdm_module_detail, :stance => stance)
 				end
 			end
@@ -852,11 +852,11 @@ def remove_module_details
 					'server'
 				end
 
-				it "should match Mdm::Module::Detail#stance 'active'" do
+				it "should match Mdm::Module::Detail#stance 'aggressive'" do
 					module_details.count.should > 0
 
 					module_details.all? { |module_detail|
-						module_detail.stance == 'active'
+						module_detail.stance == 'aggressive'
 					}.should be_true
 				end
 			end
@@ -1469,8 +1469,8 @@ def loader.load_error(module_path, error)
 				update_module_details
 			end
 
-			it 'should call module_to_details_hash to get Mdm::Module::Detail attributs and association attributes' do
-				db_manager.should_receive(:module_to_details_hash).and_return({})
+			it 'should call module_to_details_hash to get Mdm::Module::Detail attributes and association attributes' do
+				db_manager.should_receive(:module_to_details_hash).and_call_original
 
 				update_module_details
 			end
@@ -1485,10 +1485,26 @@ def loader.load_error(module_path, error)
 			context 'module_to_details_hash' do
 				let(:module_to_details_hash) do
 					{
-							:refname => module_reference_name
+							:mtype => module_type,
+							:privileged => privileged,
+							:rank => rank,
+							:refname => module_reference_name,
+							:stance => stance
 					}
 				end
 
+				let(:privileged) do
+					FactoryGirl.generate :mdm_module_detail_privileged
+				end
+
+				let(:rank) do
+					FactoryGirl.generate :mdm_module_detail_rank
+				end
+
+				let(:stance) do
+					FactoryGirl.generate :mdm_module_detail_stance
+				end
+
 				before(:each) do
 					db_manager.stub(
 							:module_to_details_hash
@@ -1508,8 +1524,12 @@ def loader.load_error(module_path, error)
 						update_module_details
 					end
 
+					its(:mtype) { should == module_type }
+					its(:privileged) { should == privileged }
+					its(:rank) { should == rank }
 					its(:ready) { should == true }
 					its(:refname) { should == module_reference_name }
+					its(:stance) { should == stance }
 				end
 
 				context 'with :bits' do

spec/support/shared/examples/msf/db_manager/export/extract_module_detail_info_module_detail_child.rb

@@ -9,11 +9,15 @@
 		module_detail.send(attribute_name)
 	end
 
-	it "should have Mdm::Module::Detail##{attribute_name} present" do
-	  attribute.should be_present
+	it "should not have Mdm::Module::Detail##{attribute_name} nil" do
+	  attribute.should_not be_nil
 	end
 
 	it "should have Mdm::Module::Detail##{attribute_name} for #{child_node_name} content" do
-		child_node.content.should == attribute.to_s
+		if attribute == false
+			child_node.content.should be_blank
+		else
+			child_node.content.should == attribute.to_s
+		end
 	end
 end