Nmap redis-brute NSE Script


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

Script Description

The redis-brute.nse script performs brute force passwords auditing against a Redis key-value store.

Redis-brute NSE Script Arguments

This is a full list of arguments supported by the redis-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

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

Redis-brute NSE Script Example Usage

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

nmap -p 6379 <ip> --script redis-brute

Redis-brute NSE Script Example Output

Here's a sample output from the redis-brute.nse script:

PORT     STATE SERVICE
6379/tcp open  unknown
| redis-brute:
|   Accounts
|     toledo - Valid credentials
|   Statistics
|_    Performed 5000 guesses in 3 seconds, average tps: 1666

Redis-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 redis-brute.nse script:

Visit Nmap NSE Library for more scripts.

The redis-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.

-ERR invalid password

Here is a relevant code snippet related to the "-ERR invalid password" error message:

49:	  login = function( self, username, password )
50:	    local status, response = self.helper:reqCmd("AUTH", password)
51:	
52:	    -- some error occurred, attempt to retry
53:	    if ( status and response.type == redis.Response.Type.ERROR and
54:	      "-ERR invalid password" == response.data ) then
55:	      return false, brute.Error:new( "Incorrect password" )
56:	    elseif ( status and response.type == redis.Response.Type.STATUS and
57:	      "+OK" ) then
58:	      return true, creds.Account:new( "", password, creds.State.VALID)
59:	    else

Incorrect password

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

50:	    local status, response = self.helper:reqCmd("AUTH", password)
51:	
52:	    -- some error occurred, attempt to retry
53:	    if ( status and response.type == redis.Response.Type.ERROR and
54:	      "-ERR invalid password" == response.data ) then
55:	      return false, brute.Error:new( "Incorrect password" )
56:	    elseif ( status and response.type == redis.Response.Type.STATUS and
57:	      "+OK" ) then
58:	      return true, creds.Account:new( "", password, creds.State.VALID)
59:	    else
60:	      local err = brute.Error:new( response.data )

Failed to connect to server

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

74:	local function checkRedis(host, port)
75:	
76:	  local helper = redis.Helper:new(host, port)
77:	  local status = helper:connect()
78:	  if( not(status) ) then
79:	    return false, "Failed to connect to server"
80:	  end
81:	
82:	  local status, response = helper:reqCmd("INFO")
83:	  if ( not(status) ) then
84:	    return false, "Failed to request INFO command"

Failed to request INFO command

Here is a relevant code snippet related to the "Failed to request INFO command" error message:

79:	    return false, "Failed to connect to server"
80:	  end
81:	
82:	  local status, response = helper:reqCmd("INFO")
83:	  if ( not(status) ) then
84:	    return false, "Failed to request INFO command"
85:	  end
86:	
87:	  if ( redis.Response.Type.ERROR == response.type ) then
88:	    if ( "-ERR operation not permitted" == response.data ) or
89:	        ( "-NOAUTH Authentication required." == response.data) then

Server does not require authentication

Here is a relevant code snippet related to the "Server does not require authentication" error message:

89:	        ( "-NOAUTH Authentication required." == response.data) then
90:	      return true
91:	    end
92:	  end
93:	
94:	  return false, "Server does not require authentication"
95:	end
96:	
97:	action = function(host, port)
98:	
99:	  local status, err =  checkRedis(host, port)

Version

This page has been created based on Nmap version 7.92.

Go back to menu.