Shodan Host Port - Metasploit

This page contains detailed information about how to use the auxiliary/gather/shodan_host metasploit module. For list of all metasploit modules, visit the Metasploit Module Library.

Module Overview

Name: Shodan Host Port
Module: auxiliary/gather/shodan_host
Source code: modules/auxiliary/gather/shodan_host.rb
Disclosure date: -
Last modification time: 2021-08-27 17:15:33 +0000
Supported architecture(s): -
Supported platform(s): -
Target service / protocol: http, https
Target network port(s): 80, 443, 3000, 8000, 8008, 8080, 8443, 8880, 8888
List of CVEs: -

This module uses the shodan API to return all port information found on a given host IP.

Module Ranking and Traits

Module Ranking:

• normal: The exploit is otherwise reliable, but depends on a specific version and can't (or doesn't) reliably autodetect. More information about ranking can be found here.

Basic Usage

msf > use auxiliary/gather/shodan_host
msf auxiliary(shodan_host) > show targets
    ... a list of targets ...
msf auxiliary(shodan_host) > set TARGET target-id
msf auxiliary(shodan_host) > show options
    ... show and set options ...
msf auxiliary(shodan_host) > exploit

Required Options

• RHOSTS: The target host(s), range CIDR identifier, or hosts file with syntax 'file:<path>'

• SHODAN_APIKEY: The SHODAN API key

Knowledge Base

msf6 > use auxiliary/gather/shodan_host
msf6 auxiliary(gather/shodan_host) > show options

Module options (auxiliary/gather/shodan_host):

   Name           Current Setting  Required  Description
   ----           ---------------  --------  -----------
   Proxies                         no        A proxy chain of format type:host:port[,type:host:port][...]
   RHOSTS                          yes       The target host(s), range CIDR identifier, or hosts file with syntax 'file:'
   SHODAN_APIKEY                   yes       The SHODAN API key

msf6 auxiliary(gather/shodan_host) > set RHOSTS 8.8.8.8
RHOSTS => 8.8.8.8
msf6 auxiliary(gather/shodan_host) > set SHODAN_APIKEY *redacted*
SHODAN_APIKEY => *redacted*
msf6 auxiliary(gather/shodan_host) > run
[*] Running module against 8.8.8.8

[+] 8.8.8.8:53
[*] Auxiliary module execution completed
msf6 auxiliary(gather/shodan_host) >

msf6 > use auxiliary/gather/shodan_host
msf6 auxiliary(gather/shodan_host) > show options

Module options (auxiliary/gather/shodan_host):

   Name           Current Setting  Required  Description
   ----           ---------------  --------  -----------
   Proxies                         no        A proxy chain of format type:host:port[,type:host:port][...]
   RHOSTS                          yes       The target host(s), range CIDR identifier, or hosts file with syntax 'file:'
   SHODAN_APIKEY                   yes       The SHODAN API key

msf6 auxiliary(gather/shodan_host) > set RHOSTS www.google.com
RHOSTS => www.google.com
msf6 auxiliary(gather/shodan_host) > set SHODAN_APIKEY *redacted*
SHODAN_APIKEY => *redacted*
msf6 auxiliary(gather/shodan_host) > run
[*] Running module against 172.217.12.36

[+] 172.217.12.36:80
[+] 172.217.12.36:443
[*] Running module against 2607:f8b0:4000:815::2004
[-] The target IP address has not been scanned by Shodan!
[*] Auxiliary module execution completed
msf6 auxiliary(gather/shodan_host) >

Go back to menu.

Msfconsole Usage

Here is how the gather/shodan_host auxiliary module looks in the msfconsole:

msf6 > use auxiliary/gather/shodan_host

msf6 auxiliary(gather/shodan_host) > show info

       Name: Shodan Host Port
     Module: auxiliary/gather/shodan_host
    License: Metasploit Framework License (BSD)
       Rank: Normal

Provided by:
  natto97

Check supported:
  No

Basic options:
  Name           Current Setting  Required  Description
  ----           ---------------  --------  -----------
  Proxies                         no        A proxy chain of format type:host:port[,type:host:port][...]
  RHOSTS                          yes       The target host(s), range CIDR identifier, or hosts file with syntax 'file:<path>'
  SHODAN_APIKEY                   yes       The SHODAN API key

Description:
  This module uses the shodan API to return all port information found 
  on a given host IP.

References:
  https://honeyscore.shodan.io/

Module Options

This is a complete list of options available in the gather/shodan_host auxiliary module:

msf6 auxiliary(gather/shodan_host) > show options

Module options (auxiliary/gather/shodan_host):

   Name           Current Setting  Required  Description
   ----           ---------------  --------  -----------
   Proxies                         no        A proxy chain of format type:host:port[,type:host:port][...]
   RHOSTS                          yes       The target host(s), range CIDR identifier, or hosts file with syntax 'file:<path>'
   SHODAN_APIKEY                   yes       The SHODAN API key

Advanced Options

Here is a complete list of advanced options supported by the gather/shodan_host auxiliary module:

msf6 auxiliary(gather/shodan_host) > show advanced

Module advanced options (auxiliary/gather/shodan_host):

   Name                  Current Setting                                     Required  Description
   ----                  ---------------                                     --------  -----------
   DOMAIN                WORKSTATION                                         yes       The domain to use for Windows authentication
   DigestAuthIIS         true                                                no        Conform to IIS, should work for most servers. Only set to false for non-IIS servers
   FingerprintCheck      true                                                no        Conduct a pre-exploit fingerprint verification
   HttpClientTimeout                                                         no        HTTP connection and receive timeout
   HttpPassword                                                              no        The HTTP password to specify for authentication
   HttpRawHeaders                                                            no        Path to ERB-templatized raw headers to append to existing headers
   HttpTrace             false                                               no        Show the raw HTTP requests and responses
   HttpTraceColors       red/blu                                             no        HTTP request and response colors for HttpTrace (unset to disable)
   HttpTraceHeadersOnly  false                                               no        Show HTTP headers only in HttpTrace
   HttpUsername                                                              no        The HTTP username to specify for authentication
   SSLVersion            Auto                                                yes       Specify the version of SSL/TLS to be used (Auto, TLS and SSL23 are auto-negotiate) (Accepted: Auto, TLS, SSL23, SSL3, TLS1, TLS1.1, TLS1.2)
   UserAgent             Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)  no        The User-Agent header to use for all requests
   VERBOSE               false                                               no        Enable detailed status messages
   WORKSPACE                                                                 no        Specify the workspace for this module

Auxiliary Actions

This is a list of all auxiliary actions that the gather/shodan_host module can do:

msf6 auxiliary(gather/shodan_host) > show actions

Auxiliary actions:

   Name  Description
   ----  -----------

Evasion Options

Here is the full list of possible evasion options supported by the gather/shodan_host auxiliary module in order to evade defenses (e.g. Antivirus, EDR, Firewall, NIDS etc.):

msf6 auxiliary(gather/shodan_host) > show evasion

Module evasion options:

   Name                          Current Setting  Required  Description
   ----                          ---------------  --------  -----------
   HTTP::header_folding          false            no        Enable folding of HTTP headers
   HTTP::method_random_case      false            no        Use random casing for the HTTP method
   HTTP::method_random_invalid   false            no        Use a random invalid, HTTP method for request
   HTTP::method_random_valid     false            no        Use a random, but valid, HTTP method for request
   HTTP::pad_fake_headers        false            no        Insert random, fake headers into the HTTP request
   HTTP::pad_fake_headers_count  0                no        How many fake headers to insert into the HTTP request
   HTTP::pad_get_params          false            no        Insert random, fake query string variables into the request
   HTTP::pad_get_params_count    16               no        How many fake query string variables to insert into the request
   HTTP::pad_method_uri_count    1                no        How many whitespace characters to use between the method and uri
   HTTP::pad_method_uri_type     space            no        What type of whitespace to use between the method and uri (Accepted: space, tab, apache)
   HTTP::pad_post_params         false            no        Insert random, fake post variables into the request
   HTTP::pad_post_params_count   16               no        How many fake post variables to insert into the request
   HTTP::pad_uri_version_count   1                no        How many whitespace characters to use between the uri and version
   HTTP::pad_uri_version_type    space            no        What type of whitespace to use between the uri and version (Accepted: space, tab, apache)
   HTTP::uri_dir_fake_relative   false            no        Insert fake relative directories into the uri
   HTTP::uri_dir_self_reference  false            no        Insert self-referential directories into the uri
   HTTP::uri_encode_mode         hex-normal       no        Enable URI encoding (Accepted: none, hex-normal, hex-noslashes, hex-random, hex-all, u-normal, u-all, u-random)
   HTTP::uri_fake_end            false            no        Add a fake end of URI (eg: /%20HTTP/1.0/../../)
   HTTP::uri_fake_params_start   false            no        Add a fake start of params to the URI (eg: /%3fa=b/../)
   HTTP::uri_full_url            false            no        Use the full URL for all HTTP requests
   HTTP::uri_use_backslashes     false            no        Use back slashes instead of forward slashes in the uri
   HTTP::version_random_invalid  false            no        Use a random invalid, HTTP version for request
   HTTP::version_random_valid    false            no        Use a random, but valid, HTTP version for request

Go back to menu.

Error Messages

This module may fail with the following error messages:

Check for the possible causes from the code snippets below found in the module source code. This can often times help in identifying the root cause of the problem.

Shodan API key should be 32 characters a-z,A-Z,0-9.

Here is a relevant code snippet related to the "Shodan API key should be 32 characters a-z,A-Z,0-9." error message:

31:	  end
32:	
33:	  def run
34:	    # check our API key is somewhat sane
35:	    unless /^[a-z\d]{32}$/i.match?(datastore['SHODAN_APIKEY'])
36:	      fail_with(Failure::BadConfig, 'Shodan API key should be 32 characters a-z,A-Z,0-9.')
37:	    end
38:	    key = datastore['SHODAN_APIKEY']
39:	    # Check the length of the key (should be 32 chars)
40:	    if key.length != 32
41:	      fail_with(Failure::BadConfig, 'Invalid API key (Not long enough)')

Invalid API key (Not long enough)

Here is a relevant code snippet related to the "Invalid API key (Not long enough)" error message:

36:	      fail_with(Failure::BadConfig, 'Shodan API key should be 32 characters a-z,A-Z,0-9.')
37:	    end
38:	    key = datastore['SHODAN_APIKEY']
39:	    # Check the length of the key (should be 32 chars)
40:	    if key.length != 32
41:	      fail_with(Failure::BadConfig, 'Invalid API key (Not long enough)')
42:	    end
43:	    cli = Rex::Proto::Http::Client.new('api.shodan.io', 443, {}, true)
44:	    cli.connect
45:	    req = cli.request_cgi({
46:	      'uri' => "/shodan/host/#{rhost}?key=#{key}&minify=true",

Unable to connect to shodan

Here is a relevant code snippet related to the "Unable to connect to shodan" error message:

47:	      'method' => 'GET'
48:	    })
49:	    res = cli.send_recv(req)
50:	    cli.close
51:	    if res.nil?
52:	      fail_with(Failure::Unreachable, 'Unable to connect to shodan')
53:	    end
54:	    if res.body =~ /No information available for that IP/
55:	      print_error('The target IP address has not been scanned by Shodan!')
56:	      return
57:	    end

The target IP address has not been scanned by Shodan!

Here is a relevant code snippet related to the "The target IP address has not been scanned by Shodan!" error message:

50:	    cli.close
51:	    if res.nil?
52:	      fail_with(Failure::Unreachable, 'Unable to connect to shodan')
53:	    end
54:	    if res.body =~ /No information available for that IP/
55:	      print_error('The target IP address has not been scanned by Shodan!')
56:	      return
57:	    end
58:	    if res.code != 200
59:	      fail_with(Failure::UnexpectedReply, 'Shodan did not respond in an expected way. Check your api key')
60:	    end

Shodan did not respond in an expected way. Check your api key

Here is a relevant code snippet related to the "Shodan did not respond in an expected way. Check your api key" error message:

54:	    if res.body =~ /No information available for that IP/
55:	      print_error('The target IP address has not been scanned by Shodan!')
56:	      return
57:	    end
58:	    if res.code != 200
59:	      fail_with(Failure::UnexpectedReply, 'Shodan did not respond in an expected way. Check your api key')
60:	    end
61:	    json = res.get_json_document
62:	    if !json.nil? && !json['ports'].nil? && !json['ports'].empty?
63:	      json['ports'].each do |post|
64:	        print_good("#{rhost}:#{post}")

Shodan did not return any open ports for <RHOST>!

Here is a relevant code snippet related to the "Shodan did not return any open ports for <RHOST>!" error message:

61:	    json = res.get_json_document
62:	    if !json.nil? && !json['ports'].nil? && !json['ports'].empty?
63:	      json['ports'].each do |post|
64:	        print_good("#{rhost}:#{post}")
65:	        report_service(host: rhost, port: post, name: 'shodan')
66:	      end
67:	    else
68:	      print_error("Shodan did not return any open ports for #{rhost}!")
69:	    end
70:	  end
71:	end

Go back to menu.

Related Pull Requests

• #14429 Merged Pull Request: Create shodan_host.rb

References

• CVE: Not available
• https://honeyscore.shodan.io/

See Also

Check also the following modules related to this module:

• auxiliary/gather/shodan_honeyscore
• auxiliary/gather/shodan_search
• auxiliary/spoof/dns/bailiwicked_host
• auxiliary/gather/checkpoint_hostname
• auxiliary/scanner/http/host_header_injection
• auxiliary/scanner/msmail/host_id
• auxiliary/scanner/sap/sap_hostctrl_getcomputersystem
• auxiliary/scanner/vmware/vmware_host_details
• exploit/unix/webapp/wp_phpmailer_host_header
• exploit/windows/http/edirectory_host
• exploit/windows/http/hp_nnm_getnnmdata_hostname
• exploit/windows/http/sap_host_control_cmd_exec
• exploit/windows/proxy/bluecoat_winproxy_host
• post/linux/busybox/enum_hosts
• post/multi/gather/resolve_hosts
• post/windows/gather/enum_hostfile
• post/windows/manage/inject_host
• post/windows/manage/remove_host
• auxiliary/admin/edirectory/edirectory_dhost_cookie
• auxiliary/admin/http/tomcat_ghostcat
• auxiliary/scanner/http/vhost_scanner
• auxiliary/scanner/http/wordpress_ghost_scanner
• evasion/windows/applocker_evasion_presentationhost
• exploit/linux/http/librenms_addhost_cmd_inject
• exploit/linux/smtp/exim_gethostbyname_bof
• exploit/multi/fileformat/ghostscript_failed_restore
• exploit/unix/fileformat/ghostscript_type_confusion
• exploit/windows/local/cve_2020_0796_smbghost
• exploit/windows/misc/avaya_winpmd_unihostrouter
• exploit/windows/smb/cve_2020_0796_smbghost

Authors

• natto97

Version

This page has been produced using Metasploit Framework version 6.1.24-dev. For more modules, visit the Metasploit Module Library.

Go back to menu.