Nmap ip-geolocation-map-google NSE Script


This page contains detailed information about how to use the ip-geolocation-map-google NSE script. For list of all NSE scripts, visit the Nmap NSE Library.

Select:
Overview
Error Messages

Script Overview

Script source code: https://github.com/nmap/nmap/tree/master/scripts/ip-geolocation-map-google.nse
Script categories: external, safe
Target service / protocol: -
Target network port(s): -
List of CVEs: -

Script Description

The ip-geolocation-map-google.nse script queries the Nmap registry for the GPS coordinates of targets stored by previous geolocation scripts and renders a Google Map of markers representing the targets.

Additional information for the Google Static Maps API can be found at:

Ip-geolocation-map-google NSE Script Arguments

This is a full list of arguments supported by the ip-geolocation-map-google.nse script:

ip-geolocation-map-google.api_key

The required Google Maps API key for your account. An API key can be generated at https://developers.google.com/maps/documentation/static-maps/

ip-geolocation-map-google.center

GPS coordinates defining the center of the image. If omitted, Google Maps will choose a center that shows all the markers.

ip-geolocation-map-google.format

The default value is 'png' (alias for 'png8'), 'png32', 'gif', 'jpg', and 'jpg-baseline' are also allowed. https://developers.google.com/maps/documentation/static-maps/intro#ImageFormats

ip-geolocation-map-google.language

The default value is 'en', but other two-letter language codes are accepted.

ip-geolocation-map-google.layer

The default value is 'roadmap', 'satellite', 'hybrid', and 'terrain' are also allowed. https://developers.google.com/maps/documentation/static-maps/intro#MapTypes

ip-geolocation-map-google.map_path

The path at which the rendered Google Map will be saved to the local filesystem.

ip-geolocation-map-google.marker_style

This argument can apply styling to the markers. https://developers.google.com/maps/documentation/static-maps/intro#MarkerStyles

ip-geolocation-map-google.scale

The default value is 1, but values 2 and 4 are permitted. Scale level 4 is only available to Google Maps Premium customers. https://developers.google.com/maps/documentation/static-maps/intro#scale_values

ip-geolocation-map-google.size

The default value is '640x640' pixels, but can be increased by Google Maps Premium customers. https://developers.google.com/maps/documentation/static-maps/intro#Imagesizes

smbdomain

The domain to log in with. If you aren't in a domain environment, then anything will (should?) be accepted by the server.

smbhash

A password hash to use when logging in. This is given as a single hex string (32 characters) or a pair of hex strings (both 32 characters, optionally separated by a single character). These hashes are the LanMan or NTLM hash of the user's password, and are stored on disk or in memory. They can be retrieved from memory using the fgdump or pwdump tools.

smbnoguest

Use to disable usage of the 'guest' account.

smbpassword

The password to connect with. Be cautious with this, since some servers will lock accounts if the incorrect password is given. Although it's rare that the Administrator account can be locked out, in the off chance that it can, you could get yourself in trouble. To use a blank password, leave this parameter off altogether.

smbtype

The type of SMB authentication to use. These are the possible options:

  • v1: Sends LMv1 and NTLMv1.
  • LMv1: Sends LMv1 only.
  • NTLMv1: Sends NTLMv1 only (default).
  • v2: Sends LMv2 and NTLMv2.
  • LMv2: Sends LMv2 only.
  • NTLMv2: Doesn't exist; the protocol doesn't support NTLMv2 alone. The default, NTLMv1, is a pretty decent compromise between security and compatibility. If you are paranoid, you might want to use v2 or lmv2 for this. (Actually, if you're paranoid, you should be avoiding this protocol altogether!). If you're using an extremely old system, you might need to set this to v1 or lm, which are less secure but more compatible. For information, see smbauth.lua.

smbusername

The SMB username to log in with. The forms "DOMAIN\username" and "username@DOMAIN" are not understood. To set a domain, use the smbdomain argument.

slaxml.debug

Debug level at which default callbacks will print detailed parsing info. Default: 3

http.host

The value to use in the Host header of all requests unless otherwise set. By default, the Host header uses the output of stdnse.get_hostname().

http.max-body-size

Limit the received body to specific number of bytes. An oversized body results in an error unless script argument http.truncated-ok or request option truncated_ok is set to true. The default is 2097152 (2MB). Use value -1 to disable the limit altogether. This argument can be overridden case-by-case with request option max_body_size.

http.max-cache-size

The maximum memory size (in bytes) of the cache.

http.max-pipeline

If set, it represents the number of outstanding HTTP requests that should be sent together in a single burst. Defaults to http.pipeline (if set), or to what function get_pipeline_limit returns.

http.pipeline

If set, it represents the number of HTTP requests that'll be sent on one connection. This can be set low to make debugging easier, or it can be set high to test how a server reacts (its chosen max is ignored).

http.truncated-ok

Do not treat oversized body as error. (Use response object flag truncated to check if the returned body has been truncated.) This argument can be overridden case-by-case with request option truncated_ok.

http.useragent

The value of the User-Agent header field sent with requests. By default it is "Mozilla/5.0 (compatible; Nmap Scripting Engine; https://nmap.org/book/nse.html)". A value of the empty string disables sending the User-Agent header field.

- - -
To use these script arguments, add them to the Nmap command line using the --script-args arg1=value,[arg2=value,..] syntax. For example:

nmap --script=ip-geolocation-map-google --script-args ip-geolocation-map-google.api_key=value,ip-geolocation-map-google.center=value <target>

Ip-geolocation-map-google NSE Script Example Usage

Here's an example of how to use the ip-geolocation-map-google.nse script:

nmap -sn -Pn --script ip-geolocation-geoplugin,ip-geolocation-map-google --script-args ip-geolocation-map-google.api_key=[redacted],ip-geolocation-map-google.map_path=map.png <target>

Ip-geolocation-map-google NSE Script Example Output

Here's a sample output from the ip-geolocation-map-google.nse script:

| ip-geolocation-map-google:
|_  The map has been saved at 'map.png'.

Ip-geolocation-map-google NSE Script Example XML Output

There is no sample XML output for this module. However, by providing the -oX <file> option, Nmap will produce a XML output and save it in the file.xml file.

Author

References

See Also

Related NSE scripts to the ip-geolocation-map-google.nse script:

Visit Nmap NSE Library for more scripts.

The ip-geolocation-map-google.nse script may fail with the following error messages. Check for the possible causes by using the code snippets highlighted below found in the script source code. This can often times help in identifying the root cause of the problem.

Refused to send query since URL path is %d chararacters, but Google Maps limits to 8192.

Here is a relevant code snippet related to the "Refused to send query since URL path is %d chararacters, but Google Maps limits to 8192." error message:

81:	  stdnse.debug1("The query URL is: %s", query)
82:	
83:	  -- Check that the query string is below the 8192 character limit after
84:	  -- URL-encoding.
85:	  if #query > 8192 then
86:	    return false, ("Refused to send query since URL path is %d chararacters, but Google Maps limits to 8192."):format(#query)
87:	  end
88:	
89:	  local res = http.get("maps.googleapis.com", 80, query)
90:	  if not res or res.status ~= 200 then
91:	    return false, ("Failed to receive map using query '%s'."):format(query)

Failed to receive map using query '%s'.

Here is a relevant code snippet related to the "Failed to receive map using query '%s'." error message:

86:	    return false, ("Refused to send query since URL path is %d chararacters, but Google Maps limits to 8192."):format(#query)
87:	  end
88:	
89:	  local res = http.get("maps.googleapis.com", 80, query)
90:	  if not res or res.status ~= 200 then
91:	    return false, ("Failed to receive map using query '%s'."):format(query)
92:	  end
93:	
94:	  local f = io.open(options["map_path"], "w")
95:	  if not f then
96:	    return false, ("Failed to open file '%s'."):format(options["map_path"])

Failed to open file '%s'.

Here is a relevant code snippet related to the "Failed to open file '%s'." error message:

91:	    return false, ("Failed to receive map using query '%s'."):format(query)
92:	  end
93:	
94:	  local f = io.open(options["map_path"], "w")
95:	  if not f then
96:	    return false, ("Failed to open file '%s'."):format(options["map_path"])
97:	  end
98:	
99:	  if not f:write(res.body) then
100:	    return false, ("Failed to write file '%s'."):format(options["map_path"])
101:	  end

Failed to write file '%s'.

Here is a relevant code snippet related to the "Failed to write file '%s'." error message:

95:	  if not f then
96:	    return false, ("Failed to open file '%s'."):format(options["map_path"])
97:	  end
98:	
99:	  if not f:write(res.body) then
100:	    return false, ("Failed to write file '%s'."):format(options["map_path"])
101:	  end
102:	
103:	  f:close()
104:	
105:	  return true, ("The map has been saved at '%s'."):format(options["map_path"])

Need to specify an API key, get one at https://developers.google.com/maps/documentation/static-maps/.

Here is a relevant code snippet related to the "Need to specify an API key, get one at https://developers.google.com/maps/documentation/static-maps/." error message:

109:	  local options = {}
110:	  local params = {}
111:	
112:	  local api_key = stdnse.get_script_args(SCRIPT_NAME .. '.api_key')
113:	  if not api_key then
114:	    return false, "Need to specify an API key, get one at https://developers.google.com/maps/documentation/static-maps/."
115:	  end
116:	  params["key"] = api_key
117:	
118:	  local center = stdnse.get_script_args(SCRIPT_NAME .. ".center")
119:	  if center then

Need to specify a path for the map.

Here is a relevant code snippet related to the "Need to specify a path for the map." error message:

137:	
138:	  local map_path = stdnse.get_script_args(SCRIPT_NAME .. '.map_path')
139:	  if map_path then
140:	    options["map_path"] = map_path
141:	  else
142:	    return false, "Need to specify a path for the map."
143:	  end
144:	
145:	  local marker_style = stdnse.get_script_args(SCRIPT_NAME .. ".marker_style")
146:	  if not marker_style then
147:	    marker_style = ""

Script argument problem

Here is a relevant code snippet related to the "Script argument problem" error message:

168:	end
169:	
170:	action = function()
171:	  -- Parse and sanity check the command line arguments.
172:	  local status, params, options = oops.raise(
173:	    "Script argument problem",
174:	    parse_args())
175:	  if not status then
176:	    return params
177:	  end
178:

Version

This page has been created based on Nmap version 7.92.

Go back to menu.