Updates to only use local store dir

Author: cgranleese-r7

lib/msf/core/modules/metadata/store.rb

@@ -127,18 +127,21 @@ def load_cache_from_file_store
     }
   end
 
-  # This method uses a per-file CRC32 cache to avoid recalculating checksums for files that have not changed.
-  # It loads the cache, checks each file's mtime and size, and only recalculates the CRC32 if needed.
+  # This method checks if the current module and library files match the cached checksum.
+  # It uses a per-file CRC32 cache to avoid recalculating checksums for files that haven't changed.
+  # If no cache exists, it will create one in the user's directory.
   #
   # @return [Boolean] True if the current checksum matches the cached one
   def self.valid_checksum?
     current_checksum = get_current_checksum
-
-    get_store_cache_path
-    ensure_cache_file_exists(current_checksum)
-
     cached_sha = get_cached_checksum
 
+    # If no cached checksum exists, create the cache file with current checksum
+    if cached_sha.nil?
+      create_or_update_cache_file(get_cache_path, current_checksum)
+      return false
+    end
+
     checksums_match?(current_checksum, cached_sha)
   end
 
@@ -218,18 +221,12 @@ def self.get_per_file_cache_path
     File.join(Msf::Config.config_directory, 'store', 'per_file_metadata_cache.json')
   end
 
-  # Get the path to the cache store file
-  # @return [String] Path to the cache store file
-  def self.get_store_cache_path
+  # Get the path to the cache file
+  # @return [String] Path to the cache file
+  def self.get_cache_path
     File.join(Msf::Config.config_directory, "store", CacheMetaDataFile)
   end
 
-  # Get the path to the DB cache file
-  # @return [String] Path to the DB cache file
-  def self.get_db_cache_path
-    File.join(Msf::Config.install_root, "db", CacheMetaDataFile)
-  end
-
   # Load the per-file cache from disk
   # @param [String] cache_file Path to the cache file
   # @return [Hash] The loaded cache or an empty hash if the file doesn't exist
@@ -272,47 +269,17 @@ def self.create_or_update_cache_file(file_path, checksum)
     File.write(file_path, JSON.pretty_generate(cache_content))
   end
 
-  # Ensure the db cache file exists, creating it if necessary
-  # @param [String] current_checksum The current checksum to use if creating a new cache file
-  # @return [void]
-  def self.ensure_cache_file_exists(current_checksum)
-    # Path to the DB cache file
-    cache_db_path = get_db_cache_path
-
-    # Only create the db cache file if it doesn't exist
-    # The user's cache file (~/.msf4/store/cache_metadata_base.json) should only be created when changes are made
-    unless File.exist?(cache_db_path)
-      # Ensure directory exists
-      FileUtils.mkdir_p(File.dirname(cache_db_path))
-      cache_content = {
-        "checksum" => {
-          "crc32" => current_checksum
-        }
-      }
-      File.write(cache_db_path, JSON.pretty_generate(cache_content))
-    end
-  end
-
-  # Get the cached checksum value without creating any new files
+  # Get the cached checksum value from the user's cache file
   # @return [String, nil] The cached checksum value or nil if no cache exists
   def self.get_cached_checksum
-    cache_store_path = get_store_cache_path
-    cache_db_path = get_db_cache_path
+    cache_path = get_cache_path
 
-    # First try user's cache file
-    if File.exist?(cache_store_path)
-      cache_content = JSON.parse(File.read(cache_store_path))
+    if File.exist?(cache_path)
+      cache_content = JSON.parse(File.read(cache_path))
       return cache_content.dig('checksum', 'crc32')
     end
 
-    # Fall back to db cache file
-    if File.exist?(cache_db_path)
-      cache_content = JSON.parse(File.read(cache_db_path))
-      return cache_content.dig('checksum', 'crc32')
-    end
-
-    # If neither exists, return nil to trigger a cache rebuild
-    # This allows the build process to work with neither file present
+    # If no cache exists, return nil to trigger creation of a new cache file
     nil
   end
 
@@ -321,19 +288,7 @@ def self.get_cached_checksum
   # @param [String] current_checksum The current checksum to store in the cache
   # @return [void]
   def self.update_cache_checksum(current_checksum)
-    cache_store_path = get_store_cache_path
-    cache_db_path = get_db_cache_path
-
-    if File.exist?(cache_store_path)
-      # Update the existing user cache file
-      create_or_update_cache_file(cache_store_path, current_checksum)
-    elsif File.exist?(cache_db_path)
-      # Copy the DB cache file to the user's directory and update it
-      FileUtils.cp(cache_db_path, cache_store_path)
-      create_or_update_cache_file(cache_store_path, current_checksum)
-    else
-      # Create a new cache file if neither exists
-      create_or_update_cache_file(cache_store_path, current_checksum)
-    end
+    cache_path = get_cache_path
+    create_or_update_cache_file(cache_path, current_checksum)
   end
 end

lib/msf/ui/console/driver.rb

@@ -163,19 +163,16 @@ def initialize(prompt = DefaultPrompt, prompt_char = DefaultPromptChar, opts = {
       self.framework.init_module_paths(module_paths: opts['ModulePath'], defer_module_loads: opts['DeferModuleLoads'])
     end
 
-    # If the module cache is invalid, we need to invalidate it and update the cache.
-    # We will also need to set 'DeferModuleLoads' to false so that the modules are reloaded.
-    unless Msf::Modules::Metadata::Store.valid_checksum?
-      # Get the current checksum and update the cache with it
+    has_modified_metasploit_files = !Msf::Modules::Metadata::Store.valid_checksum?
+
+    # Update the cache checksum if files have been modified
+    if has_modified_metasploit_files
       current_checksum = Msf::Modules::Metadata::Store.get_current_checksum
       Msf::Modules::Metadata::Store.update_cache_checksum(current_checksum)
-
-      framework.threads.spawn("ModuleCacheRebuild", true) do
-        framework.modules.refresh_cache_from_module_files
-      end
     end
 
-    unless opts['DeferModuleLoads']
+    # Refresh module cache if modules are modified, or we're not deferring loads
+    if has_modified_metasploit_files || !opts['DeferModuleLoads']
       framework.threads.spawn("ModuleCacheRebuild", true) do
         framework.modules.refresh_cache_from_module_files
       end

tools/automation/cache/build_new_cache.sh

@@ -1,7 +1,6 @@
 #!/bin/sh -ex
 bundle install
 rm -f db/modules_metadata_base.json
-rm -f db/cache_metadata_base.json
 git ls-files modules/ -z | xargs -0 -n1 -P `nproc` -I{} -- git log -1 --format="%ai {}" {} | while read -r udate utime utz ufile ; do
   touch -d "$udate $utime" $ufile
 done