Nmap smb-ls NSE Script


This page contains detailed information about how to use the smb-ls 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/smb-ls.nse
Script categories: discovery, safe
Target service / protocol: smb, netbios, tcp, udp
Target network port(s): 137, 139, 445
List of CVEs: -

Script Description

The smb-ls.nse script attempts to retrieve useful information about files shared on SMB volumes. The output is intended to resemble the output of the UNIX ls command.

Smb-ls NSE Script Arguments

This is a full list of arguments supported by the smb-ls.nse script:

smb-ls.checksum

Download each file and calculate a checksum (default: false)

smb-ls.path

The path, relative to the share to list the contents from (default: root of the share)

smb-ls.pattern

The search pattern to execute (default: *)

smb-ls.share

(or smb-ls.shares) the share (or a colon-separated list of shares) to connect to (default: use shares found by smb-enum-shares)

ls.checksum

(boolean) Download each file and calculate a SHA1 checksum. Although this is a module argument, the implementation is done in each script and is currently only supported by smb-ls and http-ls

ls.empty

(boolean) Report empty volumes (with no information or error)

ls.errors

(boolean) Report errors

ls.human

(boolean) Show file sizes in human-readable format with K, M, G, T, P suffixes. Some services return human-readable sizes natively; in these cases, the size is reported as given.

ls.maxdepth

The maximum depth to recurse into a directory. If less than 0 (e.g. -1) then recursion is unlimited. (default: 0, no recursion).

ls.maxfiles

The maximum number of files to return. Set to 0 or less to disable this limit. (default: 10).

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.

randomseed

Set to a value to change the filenames/service names that are randomly generated.

smbbasic

Forces the authentication to use basic security, as opposed to "extended security". Against most modern systems, extended security should work, but there may be cases where you want to force basic. There's a chance that you'll get better results for enumerating users if you turn on basic authentication.

smbport

Override the default port choice. If smbport is open, it's used. It's assumed to be the same protocol as port 445, not port 139. Since it probably isn't possible to change Windows' ports normally, this is mostly useful if you're bouncing through a relay or something.

smbsign

Controls whether or not server signatures are checked in SMB packets. By default, on Windows, server signatures aren't enabled or required. By default, this library will always sign packets if it knows how, and will check signatures if the server says to. Possible values are:

  • force: Always check server signatures, even if server says it doesn't support them (will Probably fail, but is technically more secure).
  • negotiate: [default] Use signatures if server supports them.
  • ignore: Never check server signatures. Not recommended.
  • disable: Don't send signatures, at all, and don't check the server's. not recommended. More information on signatures can be found in smbauth.lua.

- - -
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=smb-ls --script-args smb-ls.checksum=value,smb-ls.path=value <target>

Smb-ls NSE Script Example Usage

Here's an example of how to use the smb-ls.nse script:

nmap -p 445 <ip> --script smb-ls --script-args 'share=c$,path=\temp'

nmap -p 445 <ip> --script smb-enum-shares,smb-ls

Smb-ls NSE Script Example Output

Here's a sample output from the smb-ls.nse script:

Host script results:
| smb-ls:
|   Volume \\192.168.56.101\c$\
|   SIZE   TIME                 FILENAME
|   0      2007-12-02 00:20:09  AUTOEXEC.BAT
|   0      2007-12-02 00:20:09  CONFIG.SYS
|   <DIR>  2007-12-02 00:53:39  Documents and Settings
|   <DIR>  2009-09-08 13:26:10  e5a6b742d36facb19c5192852c43
|   <DIR>  2008-12-01 02:06:29  Inetpub
|   94720  2007-02-18 00:31:38  msizap.exe
|   <DIR>  2007-12-02 00:55:01  Program Files
|   <DIR>  2008-12-01 02:05:52  temp
|   <DIR>  2011-12-16 14:40:18  usr
|   <DIR>  2007-12-02 00:42:40  WINDOWS
|   <DIR>  2007-12-02 00:22:38  wmpub
|_

Smb-ls NSE Script Example XML Output

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

 <table key="volumes">
   <table>
     <table key="files">
       <table>
         <elem key="size">0</elem>
         <elem key="time">2007-12-02 00:20:09</elem>
         <elem key="filename">AUTOEXEC.BAT</elem>
       </table>
       <table>
         <elem key="size">0</elem>
         <elem key="time">2007-12-02 00:20:09</elem>
         <elem key="filename">CONFIG.SYS</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2007-12-02 00:53:39</elem>
         <elem key="filename">Documents and Settings</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2009-09-08 13:26:10</elem>
         <elem key="filename">e5a6b742d36facb19c5192852c43</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2008-12-01 02:06:29</elem>
         <elem key="filename">Inetpub</elem>
       </table>
       <table>
         <elem key="size">94720</elem>
         <elem key="time">2007-02-18 00:31:38</elem>
         <elem key="filename">msizap.exe</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2007-12-02 00:55:01</elem>
         <elem key="filename">Program Files</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2008-12-01 02:05:52</elem>
         <elem key="filename">temp</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2011-12-16 14:40:18</elem>
         <elem key="filename">usr</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2007-12-02 00:42:40</elem>
         <elem key="filename">WINDOWS</elem>
       </table>
       <table>
         <elem key="size">&lt;DIR&gt;</elem>
         <elem key="time">2007-12-02 00:22:38</elem>
         <elem key="filename">wmpub</elem>
       </table>
     </table>
     <elem key="volume">\\192.168.1.2\Downloads</elem>
   </table>
 </table>

Author

  • Patrik Karlsson

References

See Also

Related NSE scripts to the smb-ls.nse script:

Visit Nmap NSE Library for more scripts.

The smb-ls.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.

Failed to authenticate to server (%s) for directory of \\%s\%s%s

Here is a relevant code snippet related to the "Failed to authenticate to server (%s) for directory of \\%s\%s%s" error message:

185:	    local status, smbstate = smb.start_ex(host, true, true, share,
186:	      nil, nil, nil)
187:	    if ( not(status) ) then
188:	      ls.report_error(
189:	        output,
190:	        ("Failed to authenticate to server (%s) for directory of \\\\%s\\%s%s"):format(smbstate, stdnse.get_hostname(host), share, arg_path))
191:	    else
192:	
193:	      -- remove leading slash
194:	      arg_path = ( arg_path:sub(1,2) == '\\' and arg_path:sub(2) or arg_path )
195:

Version

This page has been created based on Nmap version 7.92.

Go back to menu.