Metasploit Plugin for Filtering Hosts with nil services

filter_hosts.rb

# Filter hosts with nil services in msfconsole.
# Install by putting in `~/.msf4/plugins` and running `load filter_hosts.rb`
# Author: Jaci Brunning <jaci.brunning@gmail.com>

module Msf
  class Plugin::FilterHosts < Msf::Plugin
    def initialize(framework, opts)
      super
      add_console_dispatcher(FilterHostsCommandDispatcher)
    end

    def cleanup
      remove_console_dispatcher("Filter Hosts")
    end

    def name
      "Filter Hosts"
    end

    def desc
      "Filter Hosts utils, clearing hosts with nil services"
    end

    class FilterHostsCommandDispatcher
      include Msf::Ui::Console::CommandDispatcher
      
      def name
        "Filter Hosts"
      end

      def commands
        {
          "hosts_filter" => "Filter hosts, deleting those with no sessions"
        }
      end

      def cmd_hosts_filter
        nil_service_hosts = Mdm::Host.where(service_count: 0)
        print_status "Nil service hosts: #{nil_service_hosts.all.map(&:address).join(' ')}"
        if nil_service_hosts.empty?
          print_warning "No nil service hosts to delete!"
        else
          print_status "Delete these host? [y/n]"
          usr_input = shell.input.gets
          if usr_input.strip.downcase.start_with?("y")
            destroyed = nil_service_hosts.destroy_all
            print_good "Deleted #{destroyed.count} host(s)!"
          else
            print_status "Not deleting (user requested)"
          end
        end
      end
    end
  end
end