Nmap sip-brute NSE Script


This page contains detailed information about how to use the sip-brute 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/sip-brute.nse
Script categories: intrusive, brute
Target service / protocol: sip, tcp, udp
Target network port(s): 5060
List of CVEs: -

Script Description

The sip-brute.nse script performs brute force password auditing against Session Initiation Protocol (SIP) accounts. This protocol is most commonly associated with VoIP sessions.

Sip-brute NSE Script Arguments

This is a full list of arguments supported by the sip-brute.nse script:

creds.global

Credentials to be returned by Credentials.getCredentials regardless of the service.

creds.[service]

Credentials to be returned by Credentials.getCredentials for [service]. E.g. creds.http=admin:password

passdb

The filename of an alternate password database. Default: nselib/data/passwords.lst

unpwdb.passlimit

The maximum number of passwords passwords will return (default unlimited).

unpwdb.timelimit

The maximum amount of time that any iterator will run before stopping. The value is in seconds by default and you can follow it with ms, s, m, or h for milliseconds, seconds, minutes, or hours. For example, unpwdb.timelimit=30m or unpwdb.timelimit=.5h for 30 minutes. The default depends on the timing template level (see the module description). Use the value 0 to disable the time limit.

unpwdb.userlimit

The maximum number of usernames usernames will return (default unlimited).

userdb

The filename of an alternate username database. Default: nselib/data/usernames.lst

brute.credfile

A file containing username and password pairs delimited by '/'

brute.delay

The number of seconds to wait between guesses (default: 0)

brute.emptypass

Guess an empty password for each user (default: false)

brute.firstonly

Stop guessing after first password is found (default: false)

brute.guesses

The number of guesses to perform against each account. (default: 0 (unlimited)). The argument can be used to prevent account lockouts.

brute.mode

Can be user, pass or creds and determines what mode to run the engine in.

  • user - the unpwdb library is used to guess passwords, every password Password is tried for each user. (The user iterator is in the outer loop)
  • pass - the unpwdb library is used to guess passwords, each password Is tried for every user. (The password iterator is in the outer loop)
  • creds - a set of credentials (username and password pairs) are Guessed against the service. This allows for lists of known or common username and password combinations to be tested. If no mode is specified and the script has not added any custom iterator the pass mode will be enabled.

brute.passonly

Iterate over passwords only for services that provide only a password for authentication. (default: false)

brute.retries

The number of times to retry if recoverable failures occur. (default: 2)

brute.start

The number of threads the engine will start with. (default: 5).

brute.threads

The number of initial worker threads, the number of active threads will be automatically adjusted.

brute.unique

Make sure that each password is only guessed once (default: true)

brute.useraspass

Guess the username as password for each user (default: true)

creds.[service]

Credentials to be returned by Credentials.getCredentials for [service]. E.g. creds.http=admin:password

sip.timeout

Specifies the session (socket) timeout in seconds

- - -
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=sip-brute --script-args creds.global=value,creds.\[service]=value <target>

Sip-brute NSE Script Example Usage

Here's an example of how to use the sip-brute.nse script:

nmap -sU -p 5060 <target> --script=sip-brute

Sip-brute NSE Script Example Output

There is no sample output for this module.

Sip-brute 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

  • Patrik Karlsson

References

See Also

Related NSE scripts to the sip-brute.nse script:

Visit Nmap NSE Library for more scripts.

The sip-brute.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.

ERROR: Failed to connect to SIP server

Here is a relevant code snippet related to the "ERROR: Failed to connect to SIP server" error message:

45:	
46:	  connect = function( self )
47:	    self.helper = sip.Helper:new(self.host, self.port, { expires = 0 })
48:	    local status, err = self.helper:connect()
49:	    if ( not(status) ) then
50:	      return "ERROR: Failed to connect to SIP server"
51:	    end
52:	    return true
53:	  end,
54:	
55:	  login = function( self, username, password )

The systems seems to have blocked our IP

Here is a relevant code snippet related to the "The systems seems to have blocked our IP" error message:

58:	    if ( not(status) ) then
59:	      -- The 3CX System has an anti-hacking option that triggers after
60:	      -- a certain amount of guesses. This protection basically prevents
61:	      -- any connection from the offending IP at an application level.
62:	      if ( err:match("^403 Forbidden") ) then
63:	        local err = brute.Error:new("The systems seems to have blocked our IP")
64:	        err:setAbort( true )
65:	        return false, err
66:	      end
67:	      return false, brute.Error:new( "Incorrect password" )
68:	    end

Incorrect password

Here is a relevant code snippet related to the "Incorrect password" error message:

62:	      if ( err:match("^403 Forbidden") ) then
63:	        local err = brute.Error:new("The systems seems to have blocked our IP")
64:	        err:setAbort( true )
65:	        return false, err
66:	      end
67:	      return false, brute.Error:new( "Incorrect password" )
68:	    end
69:	    return true, creds.Account:new(username, password, creds.State.VALID)
70:	  end,
71:	
72:	  disconnect = function(self) return self.helper:close() end,

ERROR: Failed to connect

Here is a relevant code snippet related to the "ERROR: Failed to connect" error message:

82:	  local pass = "badpass-" .. math.random(10000)
83:	  local helper = sip.Helper:new(host, port, { expires = 0 })
84:	
85:	  stdnse.debug2("Checking bad user: %s/%s", user, pass)
86:	  local status, err = helper:connect()
87:	  if ( not(status) ) then return false, "ERROR: Failed to connect" end
88:	
89:	  helper:setCredentials(user, pass)
90:	  local status, err = helper:register()
91:	  helper:close()
92:	  return status, err

nERROR: Cannot detect non-existing user accounts, this will result in:n

Here is a relevant code snippet related to the "nERROR: Cannot detect non-existing user accounts, this will result in:n" error message:

96:	  local force = stdnse.get_script_args("sip-brute.force")
97:	
98:	  if ( not(force) ) then
99:	    local status = checkBadUser(host, port)
100:	    if ( status ) then
101:	      return "\nERROR: Cannot detect non-existing user accounts, this will result in:\n" ..
102:	        "  * Non-existing accounts being detected as found\n" ..
103:	        "  * Passwords for existing accounts being correctly detected\n\n" ..
104:	        "Supply the sip-brute.force argument to override"
105:	    end
106:	  end

Version

This page has been created based on Nmap version 7.92.

Go back to menu.