Update in-memory cache to fix file_changed?

[#47720609]

Msf::ModuleManager#module_info_by_path was not being updated when a
module was loaded, so if a load_module was called again, say during
start up of prosvc, the module would reload even though there was no
change in the file because file_changed? couldn't find an entry for the
module's path in module_info_by_path.

Author: limhoff-r7

lib/msf/core/module_manager/cache.rb

@@ -15,6 +15,23 @@ def cache_empty?
     module_info_by_path.empty?
   end
 
+	# Updates the in-memory cache so that {#file_changed?} will report +false+ if
+	# the module is loaded again.
+	#
+	# @param klass [Class<Msf::Module>] a module class
+	# @return [void]
+	def cache_in_memory(klass)
+		modification_time = File.mtime(klass.file_path)
+		parent_path = klass.parent.parent_path
+
+		module_info_by_path[klass.file_path] = {
+				:modification_time => modification_time,
+				:parent_path => parent_path,
+				:reference_name => klass.refname,
+				:type => klass.type
+		}
+	end
+
   # Forces loading of the module with the given type and module reference name from the cache.
   #
   # @param [String] type the type of the module.

lib/msf/core/module_manager/loading.rb

@@ -70,6 +70,8 @@ def on_module_load(klass, type, reference_name, info={})
     module_set = module_set_by_type[type]
     annotated_klass = module_set.add_module(klass, reference_name, info)
 
+    cache_in_memory(annotated_klass)
+
     # Automatically subscribe a wrapper around this module to the necessary
     # event providers based on whatever events it wishes to receive.
     auto_subscribe_module(annotated_klass)

spec/lib/msf/core/modules/loader/directory_spec.rb

@@ -56,6 +56,16 @@
 
 					created_module.name.should == 'Microsoft Server Service Relative Path Stack Corruption'
 				end
+
+				context 'with module previously loaded' do
+					before(:each) do
+						subject.load_module(parent_path, type, module_reference_name)
+					end
+
+					it 'should not load the module' do
+						subject.load_module(parent_path, type, module_reference_name).should be_false
+					end
+				end
 			end
 
 			context 'without existent module_path' do

spec/support/shared/examples/msf/module_manager/cache.rb

@@ -1,4 +1,35 @@
 shared_examples_for 'Msf::ModuleManager::Cache' do
+	let(:parent_path) do
+		parent_pathname.to_path
+	end
+
+	let(:parent_pathname) do
+		Metasploit::Framework.root.join('modules')
+	end
+
+	let(:reference_name) do
+		'windows/smb/ms08_067_netapi'
+	end
+
+	let(:type) do
+		'exploit'
+	end
+
+	let(:path) do
+		pathname.to_path
+	end
+
+	let(:pathname) do
+		parent_pathname.join(
+				'exploits',
+				"#{reference_name}.rb"
+		)
+	end
+
+	let(:pathname_modification_time) do
+		pathname.mtime
+	end
+
 	context '#cache_empty?' do
 		subject(:cache_empty?) do
 			module_manager.cache_empty?
@@ -27,19 +58,73 @@
 		end
 	end
 
-	context '#load_cached_module' do
-		let(:parent_path) do
-			Metasploit::Framework.root.join('modules').to_path
+	context '#cache_in_memory' do
+		def cache_in_memory
+			module_manager.cache_in_memory(klass)
 		end
 
-		let(:reference_name) do
-			'windows/smb/ms08_067_netapi'
+		def module_info_by_path
+			module_manager.send(:module_info_by_path)
+		end
+
+		let(:klass) do
+			mock(
+					'Class<Msf::Module>',
+					:file_path => path,
+					:parent => namespace_module,
+					:refname => reference_name,
+					:type => type
+			)
 		end
 
-		let(:type) do
-			'exploit'
+		let(:namespace_module) do
+			mock('Msf::Modules::Namespace', :parent_path => parent_path)
 		end
 
+		it 'should update module_info_by_path' do
+			expect {
+				cache_in_memory
+			}.to change { module_info_by_path }
+		end
+
+		context 'module_info_by_path' do
+			subject(:module_info_by_path) do
+				module_manager.send(:module_info_by_path)
+			end
+
+			before(:each) do
+				cache_in_memory
+			end
+
+			it 'should have entry for file_path' do
+				module_info_by_path[klass.file_path].should be_a Hash
+			end
+
+			context 'value' do
+				subject(:value) do
+					module_info_by_path[klass.file_path]
+				end
+
+				it 'should have modification time of file_path for :modification_time' do
+					value[:modification_time].should == pathname_modification_time
+				end
+
+				it 'should have parent path from namespace module for :parent_path' do
+					value[:parent_path].should == namespace_module.parent_path
+				end
+
+				it 'should have refname for :reference_name' do
+					value[:reference_name].should == klass.refname
+				end
+
+				it 'should have type for :type' do
+					value[:type].should == klass.type
+				end
+			end
+		end
+	end
+
+	context '#load_cached_module' do
 		subject(:load_cached_module) do
 			module_manager.load_cached_module(type, reference_name)
 		end
@@ -284,39 +369,8 @@ def module_info_by_path_from_database!
       end
 
 			context 'with database cache' do
-				let(:parent_path) do
-					parent_pathname.to_path
-				end
-
-				let(:parent_pathname) do
-						Metasploit::Framework.root.join('modules')
-				end
-
-				let(:path) do
-					pathname.to_path
-				end
-
-				let(:pathname) do
-					parent_pathname.join(
-							'exploits',
-							"#{reference_name}.rb"
-					)
-				end
-
-				let(:pathname_modification_time) do
-					pathname.mtime
-				end
-
-				let(:type) do
-          'exploit'
-				end
-
-				let(:reference_name) do
-					'windows/smb/ms08_067_netapi'
-				end
-
 				#
-			  # Let!s (let + before(:each))
+				# Let!s (let + before(:each))
 				#
 
 				let!(:mdm_module_detail) do

spec/support/shared/examples/msf/module_manager/loading.rb

@@ -78,13 +78,24 @@
 	end
 
 	context '#on_module_load' do
+		def module_info_by_path
+			module_manager.send(:module_info_by_path)
+		end
+
 	  def on_module_load
 			module_manager.on_module_load(klass, type, reference_name, options)
 		end
 
 		let(:annotated_class) do
 			# stub out include? so calls in auto_subscribe_module work.
-			mock('Annotated Class', :include? => false)
+			mock(
+					'Annotated Class',
+					:file_path => path,
+					:include? => false,
+					:parent => namespace_module,
+					:refname => reference_name,
+					:type => type
+			)
 		end
 
 		let(:klass) do
@@ -95,6 +106,10 @@ def on_module_load
 			module_manager.module_set(type)
 		end
 
+		let(:namespace_module) do
+			mock('Namespace Module', :parent_path => parent_path)
+		end
+
 		let(:options) do
 			{
 					'files' => [
@@ -107,24 +122,28 @@ def on_module_load
 			}
 		end
 
+		let(:parent_path) do
+			Metasploit::Framework.root.join('modules')
+		end
+
 		let(:path) do
 			type_directory = Mdm::Module::Detail::DIRECTORY_BY_TYPE[type]
 
-			Metasploit::Framework.root.join(
-					'modules',
-					type_directory,
-					"#{reference_name}.rb"
-			).to_path
+			File.join(parent_path, type_directory, "#{reference_name}.rb")
 		end
 
 		let(:reference_name) do
-			FactoryGirl.generate :mdm_module_detail_refname
+			'admin/2wire/xslt_password_reset'
 		end
 
 		let(:type) do
 			klass.type
 		end
 
+		before(:each) do
+			klass.stub(:parent => namespace_module)
+		end
+
 		it "should add module to type's module_set" do
 			module_set.should_receive(:add_module).with(
 					klass,
@@ -135,6 +154,12 @@ def on_module_load
 			on_module_load
 		end
 
+		it 'should call cache_in_memory' do
+			module_manager.should_receive(:cache_in_memory)
+
+			on_module_load
+		end
+
 		context 'annotated class' do
 			before(:each) do
 				module_set.stub(:add_module).and_return(annotated_class)
@@ -155,7 +180,5 @@ def on_module_load
 				on_module_load
 			end
 		end
-
-
 	end
 end