Class: Msf::Ui::Console::CommandDispatcher::Db

Inherits:
Object
  • Object
show all
Includes:
Auxiliary::Report, Msf::Ui::Console::CommandDispatcher
Defined in:
lib/msf/ui/console/command_dispatcher/db.rb

Instance Attribute Summary

Attributes included from Msf::Ui::Console::CommandDispatcher

#driver

Attributes included from Rex::Ui::Text::DispatcherShell::CommandDispatcher

#shell, #tab_complete_items

Instance Method Summary collapse

Methods included from Auxiliary::Report

#db, #get_client, #get_host, #initialize, #inside_workspace_boundary?, #mytask, #myworkspace, #report_auth_info, #report_client, #report_exploit, #report_host, #report_loot, #report_note, #report_service, #report_vuln, #report_web_form, #report_web_page, #report_web_site, #report_web_vuln, #store_cred, #store_local, #store_loot

Methods included from Msf::Ui::Console::CommandDispatcher

#active_module, #active_module=, #active_session, #active_session=, #defanged?, #framework, #initialize, #log_error

Methods included from Rex::Ui::Text::DispatcherShell::CommandDispatcher

#cmd_help, #cmd_help_help, #cmd_help_tabs, #deprecated_cmd, #deprecated_help, #help_to_s, #initialize, #print, #print_error, #print_good, #print_line, #print_status, #print_warning, #tab_complete_filenames, #update_prompt

Instance Method Details

#active?Boolean

Returns true if the db is connected, prints an error and returns false if not.

All commands that require an active database should call this before doing anything.

Returns:

  • (Boolean)

76
77
78
79
80
81
82
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 76

def active?
  if not framework.db.active
    print_error("Database not connected")
    return false
  end
  true
end

#arg_host_range(arg, host_ranges, required = false) ⇒ Boolean

Note:

This modifies host_ranges in place

Parse arg into a RangeWalker and append the result into host_ranges

Parameters:

  • arg (String)

    The thing to turn into a RangeWalker

  • host_ranges (Array)

    The array of ranges to append

  • required (Boolean) (defaults to: false)

    Whether an empty arg should be an error

Returns:

  • (Boolean)

    true if parsing was successful or false otherwise


1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1800

def arg_host_range(arg, host_ranges, required=false)
  if (!arg and required)
    print_error("Missing required host argument")
    return false
  end
  begin
    rw = Rex::Socket::RangeWalker.new(arg)
  rescue
    print_error("Invalid host parameter, #{arg}.")
    return false
  end

  if rw.valid?
    host_ranges << rw
  else
    print_error("Invalid host parameter, #{arg}.")
    return false
  end
  return true
end

#arg_port_range(arg, port_ranges, required = false) ⇒ Object

Parse arg into an array of ports and append the result into port_ranges

Returns true if parsing was successful or nil otherwise.

NOTE: This modifies port_ranges


1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1828

def arg_port_range(arg, port_ranges, required=false)
  if (!arg and required)
    print_error("Argument required for -p")
    return
  end
  begin
    port_ranges << Rex::Socket.portspec_to_portlist(arg)
  rescue
    print_error("Invalid port parameter, #{arg}.")
    return
  end
  return true
end

#cmd_creds(*args) ⇒ Object

Can return return active or all, on a certain host or range, on a certain port or range, and/or on a service name.


681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 681

def cmd_creds(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {

  search_param = nil
  inactive_ok = false
  type = "password"

  set_rhosts = false
  output_file = nil

  host_ranges = []
  port_ranges = []
  rhosts      = []
  svcs        = []
  delete_count = 0
  search_term = nil

  cred_table_columns = [ 'host', 'port', 'user', 'pass', 'type', 'proof', 'active?' ]
  user = nil

  # Short-circuit help
  if args.delete "-h"
    cmd_creds_help
    return
  end

  mode = :search
  while (arg = args.shift)
    case arg
    when "-a","--add"
      mode = :add
    when "-d"
      mode = :delete
    when "-h"
      cmd_creds_help
      return
    when '-o'
      output_file = args.shift
      if (!output_file)
        print_error("Invalid output filename")
        return
      end
      output_file = ::File.expand_path(output_file)
    when "-p","--port"
      unless (arg_port_range(args.shift, port_ranges, true))
        return
      end
    when "-t","--type"
      ptype = args.shift
      if (!ptype)
        print_error("Argument required for -t")
        return
      end
    when "-s","--service"
      service = args.shift
      if (!service)
        print_error("Argument required for -s")
        return
      end
      svcs = service.split(/[\s]*,[\s]*/)
    when "-P","--password"
      pass = args.shift
      if (!pass)
        print_error("Argument required for -P")
        return
      end
    when "-R"
      set_rhosts = true
    when '-S', '--search'
      search_term = /#{args.shift}/nmi
    when "-u","--user"
      user = args.shift
      if (!user)
        print_error("Argument required for -u")
        return
      end
    when '-c','--columns'
      columns = args.shift
      unless columns
        print_error("Argument required for -c, you may use any of #{cred_table_columns.join(',')}")
        return
      end
      cred_table_columns = columns.split(/[\s]*,[\s]*/).select do |col|
        cred_table_columns.include?(col)
      end
      if cred_table_columns.empty?
        print_error("Argument -c requires valid columns")
        return
      end
    when "all"
      # The user wants inactive passwords, too
      inactive_ok = true
    else
      # Anything that wasn't an option is a host to search for
      unless (arg_host_range(arg, host_ranges))
        return
      end
    end
  end

  if mode == :add
    if port_ranges.length != 1 or port_ranges.first.length != 1
      print_error("Exactly one port required")
      return
    end
    port = port_ranges.first.first
    host_ranges.each do |range|
      range.each do |host|
        cred = framework.db.find_or_create_cred(
          :host => host,
          :port => port,
          :user => (user == "NULL" ? nil : user),
          :pass => (pass == "NULL" ? nil : pass),
          :type => ptype,
          :sname => service,
          :active => true
        )
        print_status("Time: #{cred.updated_at} Credential: host=#{cred.service.host.address} port=#{cred.service.port} proto=#{cred.service.proto} sname=#{cred.service.name} type=#{cred.ptype} user=#{cred.user} pass=#{cred.pass} active=#{cred.active}")
      end
    end
    return
  end

  # If we get here, we're searching.  Delete implies search
  if user
    user_regex = Regexp.compile(user)
  end

  # normalize
  ports = port_ranges.flatten.uniq
  svcs.flatten!
  tbl_opts = {
    'Header'  => "Credentials",
    'Columns' => cred_table_columns
  }

  tbl_opts.merge!(
    'ColProps' => {
      'pass'  => { 'MaxChar' => 64 },
      'proof' => { 'MaxChar' => 56 }
    }
  ) if search_term.nil?
  tbl = Rex::Ui::Text::Table.new(tbl_opts)

  creds_returned = 0
  inactive_count = 0
  # Now do the actual search
  framework.db.each_cred(framework.db.workspace) do |cred|
    # skip if it's inactive and user didn't ask for all
    if !cred.active && !inactive_ok
      inactive_count += 1
      next
    end

    if search_term
      next unless cred.attribute_names.any? { |a| cred[a.intern].to_s.match(search_term) }
    end
    # Also skip if the user is searching for something and this
    # one doesn't match
    includes = false
    host_ranges.map do |rw|
      includes = rw.include? cred.service.host.address
      break if includes
    end
    next unless host_ranges.empty? or includes

    # Same for ports
    next unless ports.empty? or ports.include? cred.service.port

    # Same for service names
    next unless svcs.empty? or svcs.include?(cred.service.name)

    if user_regex
      next unless user_regex.match(cred.user)
    end

    row = cred_table_columns.map do |col|
      case col
      when 'host'
        cred.service.host.address
      when 'port'
        cred.service.port
      when 'type'
        cred.ptype
      else
        cred.send(col.intern)
      end
    end

    tbl << row
    if mode == :delete
      cred.destroy
      delete_count += 1
    end
    if set_rhosts
      addr = (cred.service.host.scope ? cred.service.host.address + '%' + cred.service.host.scope : cred.service.host.address )
      rhosts << addr
    end
    creds_returned += 1
  end

  print_line
  if output_file.nil?
    print_line(tbl.to_s)
    if !inactive_ok && inactive_count > 0
      # Then we're not printing the inactive ones. Let the user know
      # that there are some they are not seeing and how to get at
      # them.
      print_line "Also found #{inactive_count} inactive creds (`creds all` to list them)"
      print_line
    end
  else
    # create the output file
    ::File.open(output_file, "wb") { |f| f.write(tbl.to_csv) }
    print_status("Wrote services to #{output_file}")
  end

  set_rhosts_from_addrs(rhosts.uniq) if set_rhosts

  print_status("Deleted #{delete_count} credentials") if delete_count > 0
}
end

#cmd_creds_helpObject


650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 650

def cmd_creds_help
  print_line "Usage: creds [addr range]"
  print_line "Usage: creds -a <addr range> -p <port> -t <type> -u <user> -P <pass>"
  print_line
  print_line "  -a,--add              Add creds to the given addresses instead of listing"
  print_line "  -d,--delete           Delete the creds instead of searching"
  print_line "  -h,--help             Show this help information"
  print_line "  -o <file>             Send output to a file in csv format"
  print_line "  -p,--port <portspec>  List creds matching this port spec"
  print_line "  -s <svc names>        List creds matching these service names"
  print_line "  -t,--type <type>      Add a cred of this type (only with -a). Default: password"
  print_line "  -u,--user             Add a cred for this user (only with -a). Default: blank"
  print_line "  -P,--password         Add a cred with this password (only with -a). Default: blank"
  print_line "  -R,--rhosts           Set RHOSTS from the results of the search"
  print_line "  -S,--search           Search string to filter by"
  print_line "  -c,--columns          Columns of interest"

  print_line
  print_line "Examples:"
  print_line "  creds               # Default, returns all active credentials"
  print_line "  creds all           # Returns all credentials active or not"
  print_line "  creds 1.2.3.4/24    # nmap host specification"
  print_line "  creds -p 22-25,445  # nmap port specification"
  print_line "  creds 10.1.*.* -s ssh,smb all"
  print_line
end

#cmd_db_autopwn(*args) ⇒ Object

:category: Deprecated Commands


1279
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1279

def cmd_db_autopwn(*args); deprecated_cmd; end

#cmd_db_autopwn_helpObject

:category: Deprecated Commands


1266
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1266

def cmd_db_autopwn_help; deprecated_help; end

#cmd_db_connect(*args) ⇒ Object


1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1585

def cmd_db_connect(*args)
  return if not db_check_driver
  if (args[0] == "-y")
    if (args[1] and not ::File.exists? ::File.expand_path(args[1]))
      print_error("File not found")
      return
    end
    file = args[1] || ::File.join(Msf::Config.get_config_root, "database.yml")
    file = ::File.expand_path(file)
    if (::File.exists? file)
      db = YAML.load(::File.read(file))['production']
      framework.db.connect(db)

      if framework.db.active and not framework.db.modules_cached
        print_status("Rebuilding the module cache in the background...")
        framework.threads.spawn("ModuleCacheRebuild", true) do
          framework.db.update_all_module_details
        end
      end

      return
    end
  end
  meth = "db_connect_#{framework.db.driver}"
  if(self.respond_to?(meth))
    self.send(meth, *args)
    if framework.db.active and not framework.db.modules_cached
      print_status("Rebuilding the module cache in the background...")
      framework.threads.spawn("ModuleCacheRebuild", true) do
        framework.db.update_all_module_details
      end
    end
  else
    print_error("This database driver #{framework.db.driver} is not currently supported")
  end
end

#cmd_db_connect_helpObject


1580
1581
1582
1583
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1580

def cmd_db_connect_help
  # Help is specific to each driver
  cmd_db_connect("-h")
end

#cmd_db_disconnect(*args) ⇒ Object


1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1629

def cmd_db_disconnect(*args)
  return if not db_check_driver

  if(args[0] and (args[0] == "-h" || args[0] == "--help"))
    cmd_db_disconnect_help
    return
  end

  if (framework.db)
    framework.db.disconnect()
  end
end

#cmd_db_disconnect_helpObject


1622
1623
1624
1625
1626
1627
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1622

def cmd_db_disconnect_help
  print_line "Usage: db_disconnect"
  print_line
  print_line "Disconnect from the database."
  print_line
end

#cmd_db_driver(*args) ⇒ Object

:category: Deprecated Commands

This one deserves a little more explanation than standard deprecation warning, so give the user a better understanding of what's going on.


1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1287

def cmd_db_driver(*args)
  deprecated_cmd
  print_line
  print_line "Because Metasploit no longer supports databases other than the default"
  print_line "PostgreSQL, there is no longer a need to set the driver. Thus db_driver"
  print_line "is not useful and its functionality has been removed. Usually Metasploit"
  print_line "will already have connected to the database; check db_status to see."
  print_line
  cmd_db_status
end

#cmd_db_driver_helpObject

:category: Deprecated Commands


1268
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1268

def cmd_db_driver_help; deprecated_help; end

#cmd_db_export(*args) ⇒ Object

Export an XML


1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1417

def cmd_db_export(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {

  export_formats = %W{xml pwdump}
  format = 'xml'
  output = nil

  while (arg = args.shift)
    case arg
    when '-h','--help'
      print_line "Usage:"
      print_line "    db_export -f <format> [-a] [filename]"
      print_line "    Format can be one of: #{export_formats.join(", ")}"
    when '-f','--format'
      format = args.shift.to_s.downcase
    else
      output = arg
    end
  end

  if not output
    print_error("No output file was specified")
    return
  end

  if not export_formats.include?(format)
    print_error("Unsupported file format: #{format}")
    print_error("Unsupported file format: '#{format}'. Must be one of: #{export_formats.join(", ")}")
    return
  end

  print_status("Starting export of workspace #{framework.db.workspace.name} to #{output} [ #{format} ]...")
  exporter = ::Msf::DBManager::Export.new(framework.db.workspace)

  exporter.send("to_#{format}_file".intern,output) do |mtype, mstatus, mname|
    if mtype == :status
      if mstatus == "start"
        print_status("    >> Starting export of #{mname}")
      end
      if mstatus == "complete"
        print_status("    >> Finished export of #{mname}")
      end
    end
  end
  print_status("Finished export of workspace #{framework.db.workspace.name} to #{output} [ #{format} ]...")
}
end

#cmd_db_export_helpObject


1408
1409
1410
1411
1412
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1408

def cmd_db_export_help
  # Like db_hosts and db_services, this creates a list of columns, so
  # use its -h
  cmd_db_export("-h")
end

#cmd_db_hosts(*args) ⇒ Object

:category: Deprecated Commands


1271
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1271

def cmd_db_hosts(*args); deprecated_cmd(:hosts, *args); end

#cmd_db_hosts_helpObject

:category: Deprecated Commands


1258
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1258

def cmd_db_hosts_help; deprecated_help(:hosts); end

#cmd_db_import(*args) ⇒ Object

Generic import that automatically detects the file type


1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1332

def cmd_db_import(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  if (args.include?("-h") or not (args and args.length > 0))
    cmd_db_import_help
    return
  end
  args.each { |glob|
    files = ::Dir.glob(::File.expand_path(glob))
    if files.empty?
      print_error("No such file #{glob}")
      next
    end
    files.each { |filename|
      if (not ::File.readable?(filename))
        print_error("Could not read file #{filename}")
        next
      end
      begin
        warnings = 0
        framework.db.import_file(:filename => filename) do |type,data|
          case type
          when :debug
            print_error("DEBUG: #{data.inspect}")
          when :vuln
            inst = data[1] == 1 ? "instance" : "instances"
            print_status("Importing vulnerability '#{data[0]}' (#{data[1]} #{inst})")
          when :filetype
            print_status("Importing '#{data}' data")
          when :parser
            print_status("Import: Parsing with '#{data}'")
          when :address
            print_status("Importing host #{data}")
          when :service
            print_status("Importing service #{data}")
          when :msf_loot
            print_status("Importing loot #{data}")
          when :msf_task
            print_status("Importing task #{data}")
          when :msf_report
            print_status("Importing report #{data}")
          when :pcap_count
            print_status("Import: #{data} packets processed")
          when :record_count
            print_status("Import: #{data[1]} records processed")
          when :warning
            print_error
            data.split("\n").each do |line|
              print_error(line)
            end
            print_error
            warnings += 1
          end
        end
        print_status("Successfully imported #{filename}")

        print_error("Please note that there were #{warnings} warnings") if warnings > 1
        print_error("Please note that there was one warning") if warnings == 1

      rescue DBImportError
        print_error("Failed to import #{filename}: #{$!}")
        elog("Failed to import #{filename}: #{$!.class}: #{$!}")
        dlog("Call stack: #{[email protected].join("\n")}", LEV_3)
        next
      rescue REXML::ParseException => e
        print_error("Failed to import #{filename} due to malformed XML:")
        print_error("#{$!.class}: #{$!}")
        elog("Failed to import #{filename}: #{$!.class}: #{$!}")
        dlog("Call stack: #{[email protected].join("\n")}", LEV_3)
        next
      end
    }
  }
}
end

#cmd_db_import_helpObject


1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1302

def cmd_db_import_help
  print_line "Usage: db_import <filename> [file2...]"
  print_line
  print_line "Filenames can be globs like *.xml, or **/*.xml which will search recursively"
  print_line "Currently supported file types include:"
  print_line "    Acunetix XML"
  print_line "    Amap Log"
  print_line "    Amap Log -m"
  print_line "    Appscan XML"
  print_line "    Burp Session XML"
  print_line "    Foundstone XML"
  print_line "    IP360 ASPL"
  print_line "    IP360 XML v3"
  print_line "    Microsoft Baseline Security Analyzer"
  print_line "    Nessus NBE"
  print_line "    Nessus XML (v1 and v2)"
  print_line "    NetSparker XML"
  print_line "    NeXpose Simple XML"
  print_line "    NeXpose XML Report"
  print_line "    Nmap XML"
  print_line "    OpenVAS Report"
  print_line "    Qualys Asset XML"
  print_line "    Qualys Scan XML"
  print_line "    Retina XML"
  print_line
end

#cmd_db_import_tabs(str, words) ⇒ Object


1298
1299
1300
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1298

def cmd_db_import_tabs(str, words)
  tab_complete_filenames(str, words)
end

#cmd_db_nmap(*args) ⇒ Object

Import Nmap data from a file


1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1469

def cmd_db_nmap(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  if (args.length == 0)
    print_status("Usage: db_nmap [nmap options]")
    return
  end

  save = false
  if args.include?("save")
    save = active?
    args.delete("save")
  end

  nmap =
    Rex::FileUtils.find_full_path("nmap") ||
    Rex::FileUtils.find_full_path("nmap.exe")

  if (not nmap)
    print_error("The nmap executable could not be found")
    return
  end

  fd = Tempfile.new('dbnmap')
  fd.binmode

  fo = Tempfile.new('dbnmap')
  fo.binmode

  # When executing native Nmap in Cygwin, expand the Cygwin path to a Win32 path
  if(Rex::Compat.is_cygwin and nmap =~ /cygdrive/)
    # Custom function needed because cygpath breaks on 8.3 dirs
    tout = Rex::Compat.cygwin_to_win32(fd.path)
    fout = Rex::Compat.cygwin_to_win32(fo.path)
    args.push('-oX', tout)
    args.push('-oN', fout)
  else
    args.push('-oX', fd.path)
    args.push('-oN', fo.path)
  end

  begin
    nmap_pipe = ::Open3::popen3([nmap, "nmap"], *args)
    temp_nmap_threads = []
    temp_nmap_threads << framework.threads.spawn("db_nmap-Stdout", false, nmap_pipe[1]) do |np_1|
      np_1.each_line do |nmap_out|
        next if nmap_out.strip.empty?
        print_status("Nmap: #{nmap_out.strip}")
      end
    end

    temp_nmap_threads << framework.threads.spawn("db_nmap-Stderr", false, nmap_pipe[2]) do |np_2|
      np_2.each_line do |nmap_err|
        next if nmap_err.strip.empty?
        print_status("Nmap: '#{nmap_err.strip}'")
      end
    end

    temp_nmap_threads.map {|t| t.join rescue nil}
    nmap_pipe.each {|p| p.close rescue nil}
  rescue ::IOError
  end

  fo.close(true)
  framework.db.import_nmap_xml_file(:filename => fd.path)

  if save
    fd.rewind
    saved_path = report_store_local("nmap.scan.xml", "text/xml", fd.read, "nmap_#{Time.now.utc.to_i}")
    print_status("Saved NMAP XML results to #{saved_path}")
  end
  fd.close(true)
}
end

#cmd_db_notes(*args) ⇒ Object

:category: Deprecated Commands


1273
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1273

def cmd_db_notes(*args); deprecated_cmd(:notes, *args); end

#cmd_db_notes_helpObject

:category: Deprecated Commands


1260
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1260

def cmd_db_notes_help; deprecated_help(:notes); end

#cmd_db_rebuild_cacheObject


1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1642

def cmd_db_rebuild_cache
  unless framework.db.active
    print_error("The database is not connected")
    return
  end

  print_status("Purging and rebuilding the module cache in the background...")
  framework.threads.spawn("ModuleCacheRebuild", true) do
    framework.db.purge_all_module_details
    framework.db.update_all_module_details
  end
end

#cmd_db_rebuild_cache_helpObject


1655
1656
1657
1658
1659
1660
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1655

def cmd_db_rebuild_cache_help
  print_line "Usage: db_rebuild_cache"
  print_line
  print_line "Purge and rebuild the SQL module cache."
  print_line
end

#cmd_db_services(*args) ⇒ Object

:category: Deprecated Commands


1277
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1277

def cmd_db_services(*args); deprecated_cmd(:services, *args); end

#cmd_db_services_helpObject

:category: Deprecated Commands


1264
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1264

def cmd_db_services_help; deprecated_help(:services); end

#cmd_db_status(*args) ⇒ Object

Is everything working?


1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1565

def cmd_db_status(*args)
  return if not db_check_driver
  if ::ActiveRecord::Base.connected?
    cdb = ""
    ::ActiveRecord::Base.connection_pool.with_connection { |conn|
      if conn.respond_to? :current_database
        cdb = conn.current_database
      end
    }
    print_status("#{framework.db.driver} connected to #{cdb}")
  else
    print_status("#{framework.db.driver} selected, no connection")
  end
end

#cmd_db_vulns(*args) ⇒ Object

:category: Deprecated Commands


1275
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1275

def cmd_db_vulns(*args); deprecated_cmd(:vulns, *args); end

#cmd_db_vulns_helpObject

:category: Deprecated Commands


1262
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1262

def cmd_db_vulns_help; deprecated_help(:vulns); end

#cmd_hosts(*args) ⇒ Object


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 216

def cmd_hosts(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  onlyup = false
  host_search = nil
  set_rhosts = false
  mode = :search
  delete_count = 0

  rhosts = []
  host_ranges = []
  search_term = nil

  output = nil
  default_columns = ::Mdm::Host.column_names.sort
  virtual_columns = [ 'svcs', 'vulns', 'workspace' ]

  col_search = [ 'address', 'mac', 'name', 'os_name', 'os_flavor', 'os_sp', 'purpose', 'info', 'comments']

  default_columns.delete_if {|v| (v[-2,2] == "id")}
  while (arg = args.shift)
    case arg
    when '-a','--add'
      mode = :add
    when '-d','--delete'
      mode = :delete
    when '-c'
      list = args.shift
      if(!list)
        print_error("Invalid column list")
        return
      end
      col_search = list.strip().split(",")
      col_search.each { |c|
        if not default_columns.include?(c) and not virtual_columns.include?(c)
          all_columns = default_columns + virtual_columns
          print_error("Invalid column list. Possible values are (#{all_columns.join("|")})")
          return
        end
      }
    when '-u','--up'
      onlyup = true
    when '-o'
      output = args.shift
    when '-R','--rhosts'
      set_rhosts = true
    when '-S', '--search'
      search_term = /#{args.shift}/nmi

    when '-h','--help'
      print_line "Usage: hosts [ options ] [addr1 addr2 ...]"
      print_line
      print_line "OPTIONS:"
      print_line "  -a,--add          Add the hosts instead of searching"
      print_line "  -d,--delete       Delete the hosts instead of searching"
      print_line "  -c <col1,col2>    Only show the given columns (see list below)"
      print_line "  -h,--help         Show this help information"
      print_line "  -u,--up           Only show hosts which are up"
      print_line "  -o <file>         Send output to a file in csv format"
      print_line "  -R,--rhosts       Set RHOSTS from the results of the search"
      print_line "  -S,--search       Search string to filter by"
      print_line
      print_line "Available columns: #{default_columns.join(", ")}"
      print_line
      return
    else
      # Anything that wasn't an option is a host to search for
      unless (arg_host_range(arg, host_ranges))
        return
      end
    end
  end

  if col_search
    col_names = col_search
  else
    col_names = default_columns + virtual_columns
  end

  if mode == :add
    host_ranges.each do |range|
      range.each do |address|
        host = framework.db.find_or_create_host(:host => address)
        print_status("Time: #{host.created_at} Host: host=#{host.address}")
      end
    end
    return
  end

  # If we got here, we're searching.  Delete implies search
  tbl = Rex::Ui::Text::Table.new(
    {
      'Header'  => "Hosts",
      'Columns' => col_names,
    })

  # Sentinal value meaning all
  host_ranges.push(nil) if host_ranges.empty?

  each_host_range_chunk(host_ranges) do |host_search|
    framework.db.hosts(framework.db.workspace, onlyup, host_search).each do |host|
      if search_term
        next unless host.attribute_names.any? { |a| host[a.intern].to_s.match(search_term) }
      end
      columns = col_names.map do |n|
        # Deal with the special cases
        if virtual_columns.include?(n)
          case n
          when "svcs";      host.services.length
          when "vulns";     host.vulns.length
          when "workspace"; host.workspace.name
          end
        # Otherwise, it's just an attribute
        else
          host.attributes[n] || ""
        end
      end

      tbl << columns
      if set_rhosts
        addr = (host.scope ? host.address + '%' + host.scope : host.address )
        rhosts << addr
      end
      if mode == :delete
        host.destroy
        delete_count += 1
      end
    end
  end

  if output
    print_status("Wrote hosts to #{output}")
    ::File.open(output, "wb") { |ofd|
      ofd.write(tbl.to_csv)
    }
  else
    print_line
    print_line(tbl.to_s)
  end

  # Finally, handle the case where the user wants the resulting list
  # of hosts to go into RHOSTS.
  set_rhosts_from_addrs(rhosts.uniq) if set_rhosts

  print_status("Deleted #{delete_count} hosts") if delete_count > 0
}
end

#cmd_hosts_helpObject


208
209
210
211
212
213
214
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 208

def cmd_hosts_help
  # This command does some lookups for the list of appropriate column
  # names, so instead of putting all the usage stuff here like other
  # help methods, just use it's "-h" so we don't have to recreating
  # that list
  cmd_hosts("-h")
end

#cmd_loot(*args) ⇒ Object


1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1110

def cmd_loot(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  mode = :search
  host_ranges = []
  types = nil
  delete_count = 0
  search_term = nil
  file = nil
  name = nil
  info = nil

  while (arg = args.shift)
    case arg
      when '-a','--add'
        mode = :add
      when '-d','--delete'
        mode = :delete
      when '-f','--file'
        filename = args.shift
        if(!filename)
          print_error("Can't make loot with no filename")
          return
        end
        if (!File.exists?(filename) or !File.readable?(filename))
          print_error("Can't read file")
          return
        end
      when '-i','--info'
        info = args.shift
        if(!info)
          print_error("Can't make loot with no info")
        return
      end
      when '-t'
        typelist = args.shift
        if(!typelist)
          print_error("Invalid type list")
          return
        end
        types = typelist.strip().split(",")
      when '-S', '--search'
        search_term = /#{args.shift}/nmi
      when '-h','--help'
        cmd_loot_help
        return
      else
        # Anything that wasn't an option is a host to search for
        unless (arg_host_range(arg, host_ranges))
          return
        end
    end
  end

  tbl = Rex::Ui::Text::Table.new({
      'Header'  => "Loot",
      'Columns' => [ 'host', 'service', 'type', 'name', 'content', 'info', 'path' ],
    })

  # Sentinal value meaning all
  host_ranges.push(nil) if host_ranges.empty?

if mode == :add
  if info.nil?
    print_error("Info required")
    return
  end
  if filename.nil?
    print_error("Loot file required")
    return
  end
  if types.nil? or types.size != 1
    print_error("Exactly one loot type is required")
    return
  end
  type = types.first
  name = File.basename(filename)
  host_ranges.each do |range|
    range.each do |host|
      file = File.open(filename, "rb")
      contents = file.read
      lootfile = framework.db.find_or_create_loot(:type => type, :host => host,:info => info, :data => contents,:path => filename,:name => name)
      print_status("Added loot #{host}")
    end
  end
  return
end

  each_host_range_chunk(host_ranges) do |host_search|
    framework.db.hosts(framework.db.workspace, false, host_search).each do |host|
      host.loots.each do |loot|
        next if(types and types.index(loot.ltype).nil?)
        if search_term
        next unless(
          loot.attribute_names.any? { |a| loot[a.intern].to_s.match(search_term) } or
          loot.host.attribute_names.any? { |a| loot.host[a.intern].to_s.match(search_term) }
        )
        end
        row = []
        row.push( (loot.host ? loot.host.address : "") )
        if (loot.service)
          svc = (loot.service.name ? loot.service.name : "#{loot.service.port}/#{loot.service.proto}")
          row.push svc
        else
          row.push ""
        end
        row.push(loot.ltype)
        row.push(loot.name || "")
        row.push(loot.content_type)
        row.push(loot.info || "")
        row.push(loot.path)

        tbl << row
        if (mode == :delete)
          loot.destroy
          delete_count += 1
        end
      end
    end
  end

  # Handle hostless loot
  if host_ranges.compact.empty? # Wasn't a host search
    hostless_loot = framework.db.loots.find_all_by_host_id(nil)
    hostless_loot.each do |loot|
      row = []
      row.push("")
      row.push("")
      row.push(loot.ltype)
      row.push(loot.name || "")
      row.push(loot.content_type)
      row.push(loot.info || "")
      row.push(loot.path)
      tbl << row
      if (mode == :delete)
        loot.destroy
        delete_count += 1
      end
    end
  end

  print_line
  print_line(tbl.to_s)
  print_status("Deleted #{delete_count} loots") if delete_count > 0
}
end

#cmd_loot_helpObject


1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1094

def cmd_loot_help
  print_line "Usage: loot <options>"
  print_line " Info: loot [-h] [addr1 addr2 ...] [-t <type1,type2>]"
  print_line "  Add: loot -f [fname] -i [info] -a [addr1 addr2 ...] [-t [type]"
  print_line "  Del: loot -d [addr1 addr2 ...]"
  print_line
  print_line "  -a,--add          Add loot to the list of addresses, instead of listing"
  print_line "  -d,--delete       Delete *all* loot matching host and type"
  print_line "  -f,--file         File with contents of the loot to add"
  print_line "  -i,--info         Info of the loot to add"
  print_line "  -t <type1,type2>  Search for a list of types"
  print_line "  -h,--help         Show this help information"
  print_line "  -S,--search       Search string to filter by"
  print_line
end

#cmd_notes(*args) ⇒ Object


924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 924

def cmd_notes(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  mode = :search
  data = nil
  types = nil
  set_rhosts = false

  host_ranges = []
  rhosts      = []
  search_term = nil

  while (arg = args.shift)
    case arg
    when '-a','--add'
      mode = :add
    when '-d','--delete'
      mode = :delete
    when '-n','--note'
      data = args.shift
      if(!data)
        print_error("Can't make a note with no data")
        return
      end
    when '-t'
      typelist = args.shift
      if(!typelist)
        print_error("Invalid type list")
        return
      end
      types = typelist.strip().split(",")
    when '-R', '--rhosts'
      set_rhosts = true
    when '-S', '--search'
      search_term = /#{args.shift}/nmi
    when '--sort'
      sort_term = args.shift
    when '-h','--help'
      cmd_notes_help
      return
    else
      # Anything that wasn't an option is a host to search for
      unless (arg_host_range(arg, host_ranges))
        return
      end
    end

  end

  if mode == :add
    if types.nil? or types.size != 1
      print_error("Exactly one note type is required")
      return
    end
    type = types.first
    host_ranges.each { |range|
      range.each { |addr|
        host = framework.db.find_or_create_host(:host => addr)
        break if not host
        note = framework.db.find_or_create_note(:host => host, :type => type, :data => data)
        break if not note
        print_status("Time: #{note.created_at} Note: host=#{host.address} type=#{note.ntype} data=#{note.data}")
      }
    }
    return
  end

  note_list = []
  delete_count = 0
  # No host specified - collect all notes
  if host_ranges.empty?
    note_list = framework.db.notes.dup
  # Collect notes of specified hosts
  else
    each_host_range_chunk(host_ranges) do |host_search|
      framework.db.hosts(framework.db.workspace, false, host_search).each do |host|
        note_list.concat(host.notes)
      end
    end
  end
  if search_term
    note_list.delete_if do |n|
      !n.attribute_names.any? { |a| n[a.intern].to_s.match(search_term) }
    end
  end

  # Sort the notes based on the sort_term provided
  if sort_term != nil
    sort_terms = sort_term.split(",")
    note_list.sort_by! do |note|
      orderlist = []
      sort_terms.each do |term|
        term = "ntype" if term == "type"
        term = "created_at" if term == "Time"
        if term == nil
          orderlist << ""
        elsif term == "service"
          if note.service != nil
            orderlist << make_sortable(note.service.name)
          end
        elsif term == "port"
          if note.service != nil
            orderlist << make_sortable(note.service.port)
          end
        elsif term == "output"
          orderlist << make_sortable(note.data["output"])
        elsif note.respond_to?(term)
          orderlist << make_sortable(note.send(term))
        elsif note.respond_to?(term.to_sym)
          orderlist << make_sortable(note.send(term.to_sym))
        elsif note.respond_to?("data") && note.send("data").respond_to?(term)
          orderlist << make_sortable(note.send("data").send(term))
        elsif note.respond_to?("data") && note.send("data").respond_to?(term.to_sym)
          orderlist << make_sortable(note.send("data").send(term.to_sym))
        else
          orderlist << ""
        end
      end
      orderlist
    end
  end

  # Now display them
  note_list.each do |note|
    next if(types and types.index(note.ntype).nil?)
    msg = "Time: #{note.created_at} Note:"
    if (note.host)
      host = note.host
      msg << " host=#{note.host.address}"
      if set_rhosts
        addr = (host.scope ? host.address + '%' + host.scope : host.address )
        rhosts << addr
      end
    end
    if (note.service)
      name = (note.service.name ? note.service.name : "#{note.service.port}/#{note.service.proto}")
      msg << " service=#{name}"
    end
    msg << " type=#{note.ntype} data=#{note.data.inspect}"
    print_status(msg)
    if mode == :delete
      note.destroy
      delete_count += 1
    end
  end

  # Finally, handle the case where the user wants the resulting list
  # of hosts to go into RHOSTS.
  set_rhosts_from_addrs(rhosts.uniq) if set_rhosts

  print_status("Deleted #{delete_count} notes") if delete_count > 0
}
end

#cmd_notes_helpObject


905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 905

def cmd_notes_help
  print_line "Usage: notes [-h] [-t <type1,type2>] [-n <data string>] [-a] [addr range]"
  print_line
  print_line "  -a,--add                  Add a note to the list of addresses, instead of listing"
  print_line "  -d,--delete               Delete the hosts instead of searching"
  print_line "  -n,--note <data>          Set the data for a new note (only with -a)"
  print_line "  -t <type1,type2>          Search for a list of types"
  print_line "  -h,--help                 Show this help information"
  print_line "  -R,--rhosts               Set RHOSTS from the results of the search"
  print_line "  -S,--search               Regular expression to match for search"
  print_line "  --sort <field1,field2>    Fields to sort by (case sensitive)"
  print_line
  print_line "Examples:"
  print_line "  notes --add -t apps -n 'winzip' 10.1.1.34 10.1.20.41"
  print_line "  notes -t smb.fingerprint 10.1.1.34 10.1.20.41"
  print_line "  notes -S 'nmap.nse.(http|rtsp)' --sort type,output"
  print_line
end

#cmd_services(*args) ⇒ Object


370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 370

def cmd_services(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  mode = :search
  onlyup = false
  output_file = nil
  set_rhosts = nil
  col_search = ['port', 'proto', 'name', 'state', 'info']
  default_columns = ::Mdm::Service.column_names.sort
  default_columns.delete_if {|v| (v[-2,2] == "id")}

  host_ranges  = []
  port_ranges  = []
  rhosts       = []
  delete_count = 0
  search_term  = nil

  # option parsing
  while (arg = args.shift)
    case arg
    when '-a','--add'
      mode = :add
    when '-d','--delete'
      mode = :delete
    when '-u','--up'
      onlyup = true
    when '-c'
      list = args.shift
      if(!list)
        print_error("Invalid column list")
        return
      end
      col_search = list.strip().split(",")
      col_search.each { |c|
        if not default_columns.include? c
          print_error("Invalid column list. Possible values are (#{default_columns.join("|")})")
          return
        end
      }
    when '-p'
      unless (arg_port_range(args.shift, port_ranges, true))
        return
      end
    when '-r'
      proto = args.shift
      if (!proto)
        print_status("Invalid protocol")
        return
      end
      proto = proto.strip
    when '-s'
      namelist = args.shift
      if (!namelist)
        print_error("Invalid name list")
        return
      end
      names = namelist.strip().split(",")
    when '-o'
      output_file = args.shift
      if (!output_file)
        print_error("Invalid output filename")
        return
      end
      output_file = ::File.expand_path(output_file)
    when '-R','--rhosts'
      set_rhosts = true
    when '-S', '--search'
      search_term = /#{args.shift}/nmi

    when '-h','--help'
      print_line
      print_line "Usage: services [-h] [-u] [-a] [-r <proto>] [-p <port1,port2>] [-s <name1,name2>] [-o <filename>] [addr1 addr2 ...]"
      print_line
      print_line "  -a,--add          Add the services instead of searching"
      print_line "  -d,--delete       Delete the services instead of searching"
      print_line "  -c <col1,col2>    Only show the given columns"
      print_line "  -h,--help         Show this help information"
      print_line "  -s <name1,name2>  Search for a list of service names"
      print_line "  -p <port1,port2>  Search for a list of ports"
      print_line "  -r <protocol>     Only show [tcp|udp] services"
      print_line "  -u,--up           Only show services which are up"
      print_line "  -o <file>         Send output to a file in csv format"
      print_line "  -R,--rhosts       Set RHOSTS from the results of the search"
      print_line "  -S,--search       Search string to filter by"
      print_line
      print_line "Available columns: #{default_columns.join(", ")}"
      print_line
      return
    else
      # Anything that wasn't an option is a host to search for
      unless (arg_host_range(arg, host_ranges))
        return
      end
    end
  end

  ports = port_ranges.flatten.uniq

  if mode == :add
    # Can only deal with one port and one service name at a time
    # right now.  Them's the breaks.
    if ports.length != 1
      print_error("Exactly one port required")
      return
    end
    host_ranges.each do |range|
      range.each do |addr|
        host = framework.db.find_or_create_host(:host => addr)
        next if not host
        info = {
          :host => host,
          :port => ports.first.to_i
        }
        info[:proto] = proto.downcase if proto
        info[:name]  = names.first.downcase if names and names.first

        svc = framework.db.find_or_create_service(info)
        print_status("Time: #{svc.created_at} Service: host=#{svc.host.address} port=#{svc.port} proto=#{svc.proto} name=#{svc.name}")
      end
    end
    return
  end

  # If we got here, we're searching.  Delete implies search
  col_names = default_columns
  if col_search
    col_names = col_search
  end
  tbl = Rex::Ui::Text::Table.new({
      'Header'  => "Services",
      'Columns' => ['host'] + col_names,
    })

  # Sentinal value meaning all
  host_ranges.push(nil) if host_ranges.empty?
  ports = nil if ports.empty?

  each_host_range_chunk(host_ranges) do |host_search|
    framework.db.services(framework.db.workspace, onlyup, proto, host_search, ports, names).each do |service|

      host = service.host
      if search_term
        next unless(
          host.attribute_names.any? { |a| host[a.intern].to_s.match(search_term)} or
          service.attribute_names.any? { |a| service[a.intern].to_s.match(search_term)}
        )
      end

      columns = [host.address] + col_names.map { |n| service[n].to_s || "" }
      tbl << columns
      if set_rhosts
        addr = (host.scope ? host.address + '%' + host.scope : host.address )
        rhosts << addr
      end

      if (mode == :delete)
        service.destroy
        delete_count += 1
      end
    end
  end

  print_line
  if (output_file == nil)
    print_line(tbl.to_s)
  else
    # create the output file
    ::File.open(output_file, "wb") { |f| f.write(tbl.to_csv) }
    print_status("Wrote services to #{output_file}")
  end

  # Finally, handle the case where the user wants the resulting list
  # of hosts to go into RHOSTS.
  set_rhosts_from_addrs(rhosts.uniq) if set_rhosts

  print_status("Deleted #{delete_count} services") if delete_count > 0

}
end

#cmd_services_helpObject


364
365
366
367
368
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 364

def cmd_services_help
  # Like cmd_hosts, use "-h" instead of recreating the column list
  # here
  cmd_services("-h")
end

#cmd_vulns(*args) ⇒ Object


567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 567

def cmd_vulns(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {

  host_ranges = []
  port_ranges = []
  svcs        = []
  search_term = nil
  show_info   = false

  # Short-circuit help
  if args.delete "-h"
    cmd_vulns_help
    return
  end

  mode = :search
  while (arg = args.shift)
    case arg
    #when "-a","--add"
    #	mode = :add
    #when "-d"
    #	mode = :delete
    when "-h"
      cmd_vulns_help
      return
    when "-p","--port"
      unless (arg_port_range(args.shift, port_ranges, true))
        return
      end
    when "-s","--service"
      service = args.shift
      if (!service)
        print_error("Argument required for -s")
        return
      end
      svcs = service.split(/[\s]*,[\s]*/)
    when '-S', '--search'
      search_term = /#{args.shift}/nmi
    when '-i', '--info'
      show_info = true
    else
      # Anything that wasn't an option is a host to search for
      unless (arg_host_range(arg, host_ranges))
        return
      end
    end
  end

  # normalize
  host_ranges.push(nil) if host_ranges.empty?
  ports = port_ranges.flatten.uniq
  svcs.flatten!

  each_host_range_chunk(host_ranges) do |host_search|
    framework.db.hosts(framework.db.workspace, false, host_search).each do |host|
      host.vulns.each do |vuln|
        if search_term
          next unless(
            vuln.host.attribute_names.any? { |a| vuln.host[a.intern].to_s.match(search_term) } or
            vuln.attribute_names.any? { |a| vuln[a.intern].to_s.match(search_term) }
          )
        end
        reflist = vuln.refs.map { |r| r.name }
        if(vuln.service)
          # Skip this one if the user specified a port and it
          # doesn't match.
          next unless ports.empty? or ports.include? vuln.service.port
          # Same for service names
          next unless svcs.empty? or svcs.include?(vuln.service.name)
          print_status("Time: #{vuln.created_at} Vuln: host=#{host.address} name=#{vuln.name} refs=#{reflist.join(',')} #{(show_info && vuln.info) ? "info=#{vuln.info}" : ""}")

        else
          # This vuln has no service, so it can't match
          next unless ports.empty? and svcs.empty?
          print_status("Time: #{vuln.created_at} Vuln: host=#{host.address} name=#{vuln.name} refs=#{reflist.join(',')} #{(show_info && vuln.info) ? "info=#{vuln.info}" : ""}")
        end
      end
    end
  end
}
end

#cmd_vulns_helpObject


550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 550

def cmd_vulns_help
  print_line "Print all vulnerabilities in the database"
  print_line
  print_line "Usage: vulns [addr range]"
  print_line
  print_line "  -h,--help             Show this help information"
  print_line "  -p,--port <portspec>  List vulns matching this port spec"
  print_line "  -s <svc names>        List vulns matching these service names"
  print_line "  -S,--search           Search string to filter by"
  print_line "  -i,--info             Display Vuln Info"
  print_line
  print_line "Examples:"
  print_line "  vulns -p 1-65536          # only vulns with associated services"
  print_line "  vulns -p 1-65536 -s http  # identified as http on any port"
  print_line
end

#cmd_workspace(*args) ⇒ Object


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 95

def cmd_workspace(*args)
  return unless active?
::ActiveRecord::Base.connection_pool.with_connection {
  while (arg = args.shift)
    case arg
    when '-h','--help'
      cmd_workspace_help
      return
    when '-a','--add'
      adding = true
    when '-d','--del'
      deleting = true
    when '-r','--rename'
      renaming = true
    else
      names ||= []
      names << arg
    end
  end

  if adding and names
    # Add workspaces
    workspace = nil
    names.each do |name|
      workspace = framework.db.add_workspace(name)
      print_status("Added workspace: #{workspace.name}")
    end
    framework.db.workspace = workspace
  elsif deleting and names
    switched = false
    # Delete workspaces
    names.each do |name|
      workspace = framework.db.find_workspace(name)
      if workspace.nil?
        print_error("Workspace not found: #{name}")
      elsif workspace.default?
        workspace.destroy
        workspace = framework.db.add_workspace(name)
        print_status("Deleted and recreated the default workspace")
      else
        # switch to the default workspace if we're about to delete the current one
        if framework.db.workspace.name == workspace.name
          framework.db.workspace = framework.db.default_workspace
          switched = true
        end
        # now destroy the named workspace
        workspace.destroy
        print_status("Deleted workspace: #{name}")
      end
    end
    print_status("Switched workspace: #{framework.db.workspace.name}") if switched
  elsif renaming
    if names.length != 2
      print_error("Wrong number of arguments to rename")
      return
    end
    old, new = names

    workspace = framework.db.find_workspace(old)

    old_is_active = (framework.db.workspace == workspace)
    recreate_default = workspace.default?

    if workspace.nil?
      print_error("Workspace not found: #{name}")
      return
    end

    if framework.db.find_workspace(new)
      print_error("Workspace exists: #{new}")
      return
    end

    workspace.name = new
    workspace.save!

    # Recreate the default workspace to avoid errors
    if recreate_default
      framework.db.add_workspace(old)
      print_status("Recreated default workspace after rename")
    end

    # Switch to new workspace if old name was active
    if old_is_active
      framework.db.workspace = workspace
      print_status("Switched workspace: #{framework.db.workspace.name}")
    end
  elsif names
    name = names.last
    # Switch workspace
    workspace = framework.db.find_workspace(name)
    if workspace
      framework.db.workspace = workspace
      print_status("Workspace: #{workspace.name}")
    else
      print_error("Workspace not found: #{name}")
      return
    end
  else
    # List workspaces
    framework.db.workspaces.each do |s|
      pad = (s.name == framework.db.workspace.name) ? "* " : "  "
      print_line("#{pad}#{s.name}")
    end
  end
}
end

#cmd_workspace_helpObject


84
85
86
87
88
89
90
91
92
93
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 84

def cmd_workspace_help
  print_line "Usage:"
  print_line "    workspace                  List workspaces"
  print_line "    workspace [name]           Switch workspace"
  print_line "    workspace -a [name] ...    Add workspace(s)"
  print_line "    workspace -d [name] ...    Delete workspace(s)"
  print_line "    workspace -r <old> <new>   Rename workspace"
  print_line "    workspace -h               Show this help information"
  print_line
end

#cmd_workspace_tabs(str, words) ⇒ Object


203
204
205
206
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 203

def cmd_workspace_tabs(str, words)
  return [] unless active?
  framework.db.workspaces.map { |s| s.name } if (words & ['-a','--add']).empty?
end

#commandsObject

Returns the hash of commands supported by this dispatcher.


31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 31

def commands
  base = {
    "db_connect"    => "Connect to an existing database",
    "db_disconnect" => "Disconnect from the current database instance",
    "db_status"     => "Show the current database status",
  }

  more = {
    "workspace"     => "Switch between database workspaces",
    "hosts"         => "List all hosts in the database",
    "services"      => "List all services in the database",
    "vulns"         => "List all vulnerabilities in the database",
    "notes"         => "List all notes in the database",
    "loot"          => "List all loot in the database",
    "creds"         => "List all credentials in the database",
    "db_import"     => "Import a scan result file (filetype will be auto-detected)",
    "db_export"     => "Export a file containing the contents of the database",
    "db_nmap"       => "Executes nmap and records the output automatically",
    "db_rebuild_cache" => "Rebuilds the database-stored module cache"
  }

  # Always include commands that only make sense when connected.
  # This avoids the problem of them disappearing unexpectedly if the
  # database dies or times out.  See #1923
  base.merge(more)
end

#db_check_driverObject

Database management


1554
1555
1556
1557
1558
1559
1560
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1554

def db_check_driver
  if(not framework.db.driver)
    print_error("No database driver installed. Try 'gem install pg'")
    return false
  end
  true
end

#db_connect_postgresql(*args) ⇒ Object

Connect to an existing Postgres database


1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1721

def db_connect_postgresql(*args)
  if(args[0] == nil or args[0] == "-h" or args[0] == "--help")
    print_status("   Usage: db_connect <user:pass>@<host:port>/<database>")
    print_status("      OR: db_connect -y [path/to/database.yml]")
    print_status("Examples:")
    print_status("       db_connect [email protected]")
    print_status("       db_connect user:[email protected]/metasploit3")
    print_status("       db_connect user:[email protected]:1500/metasploit3")
    return
  end

  info = db_parse_db_uri_postgresql(args[0])
  opts = { 'adapter' => 'postgresql' }

  opts['username'] = info[:user] if (info[:user])
  opts['password'] = info[:pass] if (info[:pass])
  opts['database'] = info[:name]
  opts['host'] = info[:host] if (info[:host])
  opts['port'] = info[:port] if (info[:port])

  opts['pass'] ||= ''

  # Do a little legwork to find the real database socket
  if(! opts['host'])
    while(true)
      done = false
      dirs = %W{ /var/run/postgresql /tmp }
      dirs.each do |dir|
        if(::File.directory?(dir))
          d = ::Dir.new(dir)
          d.entries.grep(/^\.s\.PGSQL.(\d+)$/).each do |ent|
            opts['port'] = ent.split('.')[-1].to_i
            opts['host'] = dir
            done = true
            break
          end
        end
        break if done
      end
      break
    end
  end

  # Default to loopback
  if(! opts['host'])
    opts['host'] = '127.0.0.1'
  end

  if (not framework.db.connect(opts))
    raise RuntimeError.new("Failed to connect to the database: #{framework.db.error}")
  end
end

#db_find_tools(tools) ⇒ Object


1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1699

def db_find_tools(tools)
  found   = true
  missed  = []
  tools.each do |name|
    if(! Rex::FileUtils.find_full_path(name))
      missed << name
    end
  end
  if(not missed.empty?)
    print_error("This database command requires the following tools to be installed: #{missed.join(", ")}")
    return
  end
  true
end

#db_parse_db_uri_postgresql(path) ⇒ Object


1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1774

def db_parse_db_uri_postgresql(path)
  res = {}
  if (path)
    auth, dest = path.split('@')
    (dest = auth and auth = nil) if not dest
    res[:user],res[:pass] = auth.split(':') if auth
    targ,name = dest.split('/')
    (name = targ and targ = nil) if not name
    res[:host],res[:port] = targ.split(':') if targ
  end
  res[:name] = name || 'metasploit3'
  res
end

#deprecated_commandsObject


58
59
60
61
62
63
64
65
66
67
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 58

def deprecated_commands
  [
    "db_autopwn",
    "db_driver",
    "db_hosts",
    "db_notes",
    "db_services",
    "db_vulns",
  ]
end

#each_host_range_chunk(host_ranges, &block) ⇒ Object

Takes host_ranges, an Array of RangeWalkers, and chunks it up into blocks of 1024.


1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1846

def each_host_range_chunk(host_ranges, &block)
  # Chunk it up and do the query in batches. The naive implementation
  # uses so much memory for a /8 that it's basically unusable (1.6
  # billion IP addresses take a rather long time to allocate).
  # Chunking has roughly the same perfomance for small batches, so
  # don't worry about it too much.
  host_ranges.each do |range|
    if range.nil? or range.length.nil?
      chunk = nil
      end_of_range = true
    else
      chunk = []
      end_of_range = false
      # Set up this chunk of hosts to search for
      while chunk.length < 1024 and chunk.length < range.length
        n = range.next_ip
        if n.nil?
          end_of_range = true
          break
        end
        chunk << n
      end
    end

    # The block will do some
    yield chunk

    # Restart the loop with the same RangeWalker if we didn't get
    # to the end of it in this chunk.
    redo unless end_of_range
  end
end

#make_sortable(input) ⇒ Object


1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1078

def make_sortable(input)
  case input.class
  when String
    input = input.downcase
  when Fixnum
    input = "%016" % input
  when Time
    input = input.strftime("%Y%m%d%H%M%S%L")
  when NilClass
    input = ""
  else
    input = input.inspect.downcase
  end
  input
end

#nameObject

The dispatcher's name.


24
25
26
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 24

def name
  "Database Backend"
end

#report_store_local(ltype = nil, ctype = nil, data = nil, filename = nil) ⇒ Object

Store some locally-generated data as a file, similiar to store_loot.


1547
1548
1549
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1547

def report_store_local(ltype=nil, ctype=nil, data=nil, filename=nil)
  store_local(ltype,ctype,data,filename)
end

#set_rhosts_from_addrs(rhosts) ⇒ Object

Set RHOSTS in the active_module's (or global if none) datastore from an array of addresses

This stores all the addresses to a temporary file and utilizes the <pre>file:/tmp/filename</pre> syntax to confer the addrs. rhosts should be an Array. NOTE: the temporary file is not deleted automatically.


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
# File 'lib/msf/ui/console/command_dispatcher/db.rb', line 1670

def set_rhosts_from_addrs(rhosts)
  if rhosts.empty?
    print_status("The list is empty, cowardly refusing to set RHOSTS")
    return
  end
  if active_module
    mydatastore = active_module.datastore
  else
    # if there is no module in use set the list to the global variable
    mydatastore = self.framework.datastore
  end

  if rhosts.length > 5
    # Lots of hosts makes 'show options' wrap which is difficult to
    # read, store to a temp file
    rhosts_file = Rex::Quickfile.new("msf-db-rhosts-")
    mydatastore['RHOSTS'] = 'file:'+rhosts_file.path
    # create the output file and assign it to the RHOSTS variable
    rhosts_file.write(rhosts.join("\n")+"\n")
    rhosts_file.close
  else
    # For short lists, just set it directly
    mydatastore['RHOSTS'] = rhosts.join(" ")
  end

  print_line "RHOSTS => #{mydatastore['RHOSTS']}"
  print_line
end