Fix DB RPC issues

[mkienow-r7]

This fixes a number of issues found in Msf::RPC::RPC_Db.

• Fix a number of incorrect method comments and examples

• Update db.notes (Msf::RPC::RPC_Db#rpc_notes) and db.vulns (Msf::RPC::RPC_Db#rpc_vulns) opts usage to match the method comment (:address rather than :addresses)

• Fix db.get_service (Msf::RPC::RPC_Db#rpc_get_service) finding a service to return
  Root cause: Mdm::Service::ActiveRecord_Associations_CollectionProxy is returned in some situations, however, the method only expects to process ::Mdm::Service or Array. This was fixed by converting the returned object to an Array.

  Before fix:

  >> rpc.call('db.get_service', {:workspace=>'default', :host => '127.0.0.1', :proto=>'tcp', :port=>80})
  => {"service"=>[{"host"=>"127.0.0.1", "created_at"=>1556298506, "updated_at"=>1556298506, "port"=>80, "proto"=>"tcp", "state"=>"open", "name"=>"http", "info"=>""}]}
  
  >> rpc.call('db.get_service', {:workspace=>'default', :proto=>'tcp', :port=>80})
  => {"service"=>[]}
  
  >> rpc.call('db.get_service', {:workspace=>'default', :host => '127.0.0.1'})
  => {"service"=>[]}
  

  After fix:

  >> rpc.call('db.get_service', {:workspace=>'default', :host => '127.0.0.1', :proto=>'tcp', :port=>80})
  => {"service"=>[{"host"=>"127.0.0.1", "created_at"=>1556298506, "updated_at"=>1556298506, "port"=>80, "proto"=>"tcp", "state"=>"open", "name"=>"http", "info"=>""}]}
  
  >> rpc.call('db.get_service', {:workspace=>'default', :proto=>'tcp', :port=>80})
  => {"service"=>[{"host"=>"127.0.0.1", "created_at"=>1556298506, "updated_at"=>1556298506, "port"=>80, "proto"=>"tcp", "state"=>"open", "name"=>"http", "info"=>""}]}
  
  >> rpc.call('db.get_service', {:workspace=>'default', :host => '127.0.0.1'})
  => {"service"=>[{"host"=>"127.0.0.1", "created_at"=>1556298506, "updated_at"=>1556298506, "port"=>80, "proto"=>"tcp", "state"=>"open", "name"=>"http", "info"=>""}]}
  

• Fix Cannot delete vuln from DB via MSF RPC #11756 - db.del_vuln (Msf::RPC::RPC_Db#rpc_del_vuln) deleting a vuln
  Root cause: Mdm::Vuln::ActiveRecord_Associations_CollectionProxy is returned in some situations, however, the code only expects to process ::Mdm::Vuln or Array. This was fixed by converting the returned object to an Array.

  Before fix:

  >> rpc.call('db.vulns', {:workspace=>'default'})
  => {"vulns"=>[]}
  
  >> rpc.call('db.report_vuln', {:workspace=>'default', :host=>'127.0.0.1', :name=>'test'})
  => {"result"=>"success"}
  
  >> rpc.call('db.vulns', {:workspace=>'default'})
  => {"vulns"=>[{"port"=>nil, "proto"=>nil, "time"=>1556292072, "host"=>"127.0.0.1", "name"=>"test", "refs"=>""}]}
  
  >> rpc.call('db.del_vuln', {:workspace=>'default', :host=>'127.0.0.1', :name=>'test'})
  => {"result"=>"success", "deleted"=>[]}
  
  >> rpc.call('db.vulns', {:workspace=>'default'})
  => {"vulns"=>[{"port"=>nil, "proto"=>nil, "time"=>1556292072, "host"=>"127.0.0.1", "name"=>"test", "refs"=>""}]}
  

  After fix:

  >> rpc.call('db.vulns', {:workspace=>'default'})
  => {"vulns"=>[]}
  
  >> rpc.call('db.report_vuln', {:workspace=>'default', :host=>'127.0.0.1', :name=>'test'})
  => {"result"=>"success"}
  
  >> rpc.call('db.vulns', {:workspace=>'default'})
  => {"vulns"=>[{"port"=>nil, "proto"=>nil, "time"=>1556292072, "host"=>"127.0.0.1", "name"=>"test", "refs"=>""}]}
  
  >> rpc.call('db.del_vuln', {:workspace=>'default', :host=>'127.0.0.1', :name=>'test'})
  => {"result"=>"success", "deleted"=>[{"address"=>"127.0.0.1", "name"=>"test"}]}
  
  >> rpc.call('db.vulns', {:workspace=>'default'})
  => {"vulns"=>[]}
  

Verification

• Use msfconsole or preferred method to create services and vulns in the database
• Start MSFRPC daemon: ./msfrpcd -P complex_password -f
• Start MSFRPC client: ./msfrpc -P complex_password -a 127.0.0.1
• Test db.notes RPC call
• Verify db.notes returns the correct notes based on the options provided
• Test db.vulns RPC call
• Verify db.vulns returns the correct notes based on the options provided
• Test db.get_service RPC call (see above for test cases)
• Verify db.get_service returns the correct service based on the options provided
• Test db.del_vuln RPC call (see above for test cases)
• Verify db.del_vuln deletes the correct vuln based on the options provided

[busterb]

Release Notes

This fixes a number of issues with manipulating the Metasploit database through RPC commands.