Nmap ip-geolocation-ipinfodb NSE Script


This page contains detailed information about how to use the ip-geolocation-ipinfodb 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-ipinfodb.nse
Script categories: discovery, external, safe
Target service / protocol: -
Target network port(s): -
List of CVEs: -

Script Description

The ip-geolocation-ipinfodb.nse script tries to identify the physical location of an IP address using the IPInfoDB geolocation web service (http://ipinfodb.com/ip_location_api.php).

There is no limit on requests to this service. However, the API key needs to be obtained through free registration for this service: http://ipinfodb.com/login.php

Ip-geolocation-ipinfodb NSE Script Arguments

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

ip-geolocation-ipinfodb.apikey

A sting specifying the api-key which the user wants to use to access this service

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-ipinfodb --script-args ip-geolocation-ipinfodb.apikey=value,smbdomain=value <target>

Ip-geolocation-ipinfodb NSE Script Example Usage

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

nmap --script ip-geolocation-ipinfodb <target> --script-args ip-geolocation-ipinfodb.apikey=<API_key>

Ip-geolocation-ipinfodb NSE Script Example Output

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

| ip-geolocation-ipinfodb:
| coordinates: 37.5384, -121.99
|_location: FREMONT, CALIFORNIA, UNITED STATES

Ip-geolocation-ipinfodb NSE Script Example XML Output

Here's a sample XML output from the ip-geolocation-ipinfodb.nse script produced by providing the -oX <file> Nmap option:

 <elem key="latitude">37.5384</elem>
 <elem key="longitude">-121.99</elem>
 <elem key="city">FREMONT</elem>
 <elem key="region">CALIFORNIA</elem>
 <elem key="country">UNITED STATES</elem>

Author

  • Gorjan Petrovski

References

See Also

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

Visit Nmap NSE Library for more scripts.

The ip-geolocation-ipinfodb.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.

not running: Error in Hostrule: %s.

Here is a relevant code snippet related to the "not running: Error in Hostrule: %s." error message:

47:	
48:	
49:	hostrule = function(host)
50:	  local is_private, err = ipOps.isPrivate( host.ip )
51:	  if is_private == nil then
52:	    stdnse.debug1("not running: Error in Hostrule: %s.", err )
53:	    return false
54:	  elseif is_private then
55:	    stdnse.debug1("not running: Private IP address of target: %s", host.ip)
56:	    return false
57:	  end

Unable to parse ipinfodb.com response

Here is a relevant code snippet related to the "Unable to parse ipinfodb.com response" error message:

68:	-- No limit on requests. A free registration for an API key is a prerequisite
69:	local ipinfodb = function(ip)
70:	  local api_key = stdnse.get_script_args(SCRIPT_NAME..".apikey")
71:	  local response = http.get("api.ipinfodb.com", 80, "/v3/ip-city/?key="..api_key.."&format=json".."&ip="..ip, {any_af=true})
72:	  local stat, loc = oops.raise(
73:	    "Unable to parse ipinfodb.com response",
74:	    json.parse(response.body))
75:	  if not stat then
76:	    return stat, loc
77:	  end
78:	  if loc.statusMessage and loc.statusMessage == "Invalid API key." then

Version

This page has been created based on Nmap version 7.92.

Go back to menu.