SMB Scanner Check File/Directory Utility - Metasploit
This page contains detailed information about how to use the auxiliary/admin/smb/check_dir_file metasploit module. For list of all metasploit modules, visit the Metasploit Module Library.
Module Overview
Name: SMB Scanner Check File/Directory Utility
Module: auxiliary/admin/smb/check_dir_file
Source code: modules/auxiliary/admin/smb/check_dir_file.rb
Disclosure date: -
Last modification time: 2020-05-13 16:34:47 +0000
Supported architecture(s): -
Supported platform(s): -
Target service / protocol: microsoft-ds, netbios-ssn
Target network port(s): 139, 445
List of CVEs: -
This module is useful when checking an entire network of SMB hosts for the presence of a known file or directory. An example would be to scan all systems for the presence of antivirus or known malware outbreak. Typically you must set RPATH, SMBUser, SMBDomain and SMBPass to operate correctly.
Module Ranking and Traits
Module Ranking:
- normal: The exploit is otherwise reliable, but depends on a specific version and can't (or doesn't) reliably autodetect. More information about ranking can be found here.
Basic Usage
This module is a scanner module, and is capable of testing against multiple hosts.
msf > use auxiliary/admin/smb/check_dir_file
msf auxiliary(check_dir_file) > show options
... show and set options ...
msf auxiliary(check_dir_file) > set RHOSTS ip-range
msf auxiliary(check_dir_file) > exploit
Other examples of setting the RHOSTS option:
Example 1:
msf auxiliary(check_dir_file) > set RHOSTS 192.168.1.3-192.168.1.200
Example 2:
msf auxiliary(check_dir_file) > set RHOSTS 192.168.1.1/24
Example 3:
msf auxiliary(check_dir_file) > set RHOSTS file:/tmp/ip_list.txt
Required Options
RHOSTS: The target host(s), range CIDR identifier, or hosts file with syntax 'file:<path>'
RPATH: The name of the remote file/directory relative to the share
Go back to menu.
Msfconsole Usage
Here is how the admin/smb/check_dir_file auxiliary module looks in the msfconsole:
msf6 > use auxiliary/admin/smb/check_dir_file
msf6 auxiliary(admin/smb/check_dir_file) > show info
Name: SMB Scanner Check File/Directory Utility
Module: auxiliary/admin/smb/check_dir_file
License: Metasploit Framework License (BSD)
Rank: Normal
Provided by:
aushack <[email protected]>
j0hn__f
Check supported:
No
Basic options:
Name Current Setting Required Description
---- --------------- -------- -----------
RHOSTS yes The target host(s), range CIDR identifier, or hosts file with syntax 'file:<path>'
RPATH yes The name of the remote file/directory relative to the share
RPORT 445 yes The SMB service port (TCP)
SMBDomain . no The Windows domain to use for authentication
SMBPass no The password for the specified username
SMBSHARE C$ yes The name of an accessible share on the server
SMBUser no The username to authenticate as
THREADS 1 yes The number of concurrent threads (max one per host)
Description:
This module is useful when checking an entire network of SMB hosts
for the presence of a known file or directory. An example would be
to scan all systems for the presence of antivirus or known malware
outbreak. Typically you must set RPATH, SMBUser, SMBDomain and
SMBPass to operate correctly.
Module Options
This is a complete list of options available in the admin/smb/check_dir_file auxiliary module:
msf6 auxiliary(admin/smb/check_dir_file) > show options
Module options (auxiliary/admin/smb/check_dir_file):
Name Current Setting Required Description
---- --------------- -------- -----------
RHOSTS yes The target host(s), range CIDR identifier, or hosts file with syntax 'file:<path>'
RPATH yes The name of the remote file/directory relative to the share
RPORT 445 yes The SMB service port (TCP)
SMBDomain . no The Windows domain to use for authentication
SMBPass no The password for the specified username
SMBSHARE C$ yes The name of an accessible share on the server
SMBUser no The username to authenticate as
THREADS 1 yes The number of concurrent threads (max one per host)
Advanced Options
Here is a complete list of advanced options supported by the admin/smb/check_dir_file auxiliary module:
msf6 auxiliary(admin/smb/check_dir_file) > show advanced
Module advanced options (auxiliary/admin/smb/check_dir_file):
Name Current Setting Required Description
---- --------------- -------- -----------
CHOST no The local client address
CPORT no The local client port
ConnectTimeout 10 yes Maximum number of seconds to establish a TCP connection
NTLM::SendLM true yes Always send the LANMAN response (except when NTLMv2_session is specified)
NTLM::SendNTLM true yes Activate the 'Negotiate NTLM key' flag, indicating the use of NTLM responses
NTLM::SendSPN true yes Send an avp of type SPN in the ntlmv2 client blob, this allows authentication on Windows 7+/Server 2008 R2+ when SPN is required
NTLM::UseLMKey false yes Activate the 'Negotiate Lan Manager Key' flag, using the LM key when the LM response is sent
NTLM::UseNTLM2_session true yes Activate the 'Negotiate NTLM2 key' flag, forcing the use of a NTLMv2_session
NTLM::UseNTLMv2 true yes Use NTLMv2 instead of NTLM2_session when 'Negotiate NTLM2' key is true
Proxies no A proxy chain of format type:host:port[,type:host:port][...]
SMB::AlwaysEncrypt true yes Enforces encryption even if the server does not require it (SMB3.x only). Note that when it is set to false, the SMB client will still encrypt the communication if the server requires it
SMB::ChunkSize 500 yes The chunk size for SMB segments, bigger values will increase speed but break NT 4.0 and SMB signing
SMB::Native_LM Windows 2000 5.0 yes The Native LM to send during authentication
SMB::Native_OS Windows 2000 2195 yes The Native OS to send during authentication
SMB::ProtocolVersion 1,2,3 yes One or a list of coma-separated SMB protocol versions to negotiate (e.g. "1" or "1,2" or "2,3,1")
SMB::VerifySignature false yes Enforces client-side verification of server response signatures
SMBDirect true no The target port is a raw SMB service (not NetBIOS)
SMBName *SMBSERVER yes The NetBIOS hostname (required for port 139 connections)
SSL false no Negotiate SSL/TLS for outgoing connections
SSLCipher no String for SSL cipher - "DHE-RSA-AES256-SHA" or "ADH"
SSLVerifyMode PEER no SSL verification method (Accepted: CLIENT_ONCE, FAIL_IF_NO_PEER_CERT, NONE, PEER)
SSLVersion Auto yes Specify the version of SSL/TLS to be used (Auto, TLS and SSL23 are auto-negotiate) (Accepted: Auto, TLS, SSL23, SSL3, TLS1, TLS1.1, TLS1.2)
ShowProgress true yes Display progress messages during a scan
ShowProgressPercent 10 yes The interval in percent that progress should be shown
VERBOSE false no Enable detailed status messages
WORKSPACE no Specify the workspace for this module
Auxiliary Actions
This is a list of all auxiliary actions that the admin/smb/check_dir_file module can do:
msf6 auxiliary(admin/smb/check_dir_file) > show actions
Auxiliary actions:
Name Description
---- -----------
Evasion Options
Here is the full list of possible evasion options supported by the admin/smb/check_dir_file auxiliary module in order to evade defenses (e.g. Antivirus, EDR, Firewall, NIDS etc.):
msf6 auxiliary(admin/smb/check_dir_file) > show evasion
Module evasion options:
Name Current Setting Required Description
---- --------------- -------- -----------
SMB::obscure_trans_pipe_level 0 yes Obscure PIPE string in TransNamedPipe (level 0-3)
SMB::pad_data_level 0 yes Place extra padding between headers and data (level 0-3)
SMB::pad_file_level 0 yes Obscure path names used in open/create (level 0-3)
SMB::pipe_evasion false yes Enable segmented read/writes for SMB Pipes
SMB::pipe_read_max_size 1024 yes Maximum buffer size for pipe reads
SMB::pipe_read_min_size 1 yes Minimum buffer size for pipe reads
SMB::pipe_write_max_size 1024 yes Maximum buffer size for pipe writes
SMB::pipe_write_min_size 1 yes Minimum buffer size for pipe writes
TCP::max_send_size 0 no Maxiumum tcp segment size. (0 = disable)
TCP::send_delay 0 no Delays inserted before every send. (0 = disable)
Go back to menu.
Error Messages
This module may fail with the following error messages:
Error Messages
- Object \<RHOST><SMBSHARE><PATH> NOT found!
- Object PATH \<RHOST><SMBSHARE><PATH> NOT found!
- Host reports access denied.
- Host is NOT connected to <SMBDOMAIN>!
- Host rejected with insufficient resources!
- opening <PATH> bad filename
- Host offline.
- Host login error.
- Unable to connect - connection refused
- Unable to connect to share <SMBSHARE>
Check for the possible causes from the code snippets below found in the module source code. This can often times help in identifying the root cause of the problem.
Object \\<RHOST>\<SMBSHARE>\<PATH> NOT found!
Here is a relevant code snippet related to the "Object \\<RHOST>\<SMBSHARE>\<PATH> NOT found!" error message:
59: if error_name
60: case error_name
61: when "STATUS_FILE_IS_A_DIRECTORY"
62: print_good("Directory FOUND: \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path}")
63: when "STATUS_OBJECT_NAME_NOT_FOUND"
64: vprint_error("Object \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
65: when "STATUS_OBJECT_PATH_NOT_FOUND"
66: vprint_error("Object PATH \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
67: when "STATUS_ACCESS_DENIED"
68: vprint_error("Host reports access denied.")
69: when "STATUS_BAD_NETWORK_NAME"
Object PATH \\<RHOST>\<SMBSHARE>\<PATH> NOT found!
Here is a relevant code snippet related to the "Object PATH \\<RHOST>\<SMBSHARE>\<PATH> NOT found!" error message:
61: when "STATUS_FILE_IS_A_DIRECTORY"
62: print_good("Directory FOUND: \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path}")
63: when "STATUS_OBJECT_NAME_NOT_FOUND"
64: vprint_error("Object \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
65: when "STATUS_OBJECT_PATH_NOT_FOUND"
66: vprint_error("Object PATH \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
67: when "STATUS_ACCESS_DENIED"
68: vprint_error("Host reports access denied.")
69: when "STATUS_BAD_NETWORK_NAME"
70: vprint_error("Host is NOT connected to #{datastore['SMBDomain']}!")
71: when "STATUS_INSUFF_SERVER_RESOURCES"
Host reports access denied.
Here is a relevant code snippet related to the "Host reports access denied." error message:
63: when "STATUS_OBJECT_NAME_NOT_FOUND"
64: vprint_error("Object \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
65: when "STATUS_OBJECT_PATH_NOT_FOUND"
66: vprint_error("Object PATH \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
67: when "STATUS_ACCESS_DENIED"
68: vprint_error("Host reports access denied.")
69: when "STATUS_BAD_NETWORK_NAME"
70: vprint_error("Host is NOT connected to #{datastore['SMBDomain']}!")
71: when "STATUS_INSUFF_SERVER_RESOURCES"
72: vprint_error("Host rejected with insufficient resources!")
73: when "STATUS_OBJECT_NAME_INVALID"
Host is NOT connected to <SMBDOMAIN>!
Here is a relevant code snippet related to the "Host is NOT connected to <SMBDOMAIN>!" error message:
65: when "STATUS_OBJECT_PATH_NOT_FOUND"
66: vprint_error("Object PATH \\\\#{rhost}\\#{datastore['SMBSHARE']}\\#{path} NOT found!")
67: when "STATUS_ACCESS_DENIED"
68: vprint_error("Host reports access denied.")
69: when "STATUS_BAD_NETWORK_NAME"
70: vprint_error("Host is NOT connected to #{datastore['SMBDomain']}!")
71: when "STATUS_INSUFF_SERVER_RESOURCES"
72: vprint_error("Host rejected with insufficient resources!")
73: when "STATUS_OBJECT_NAME_INVALID"
74: vprint_error("opening \\#{path} bad filename")
75: else
Host rejected with insufficient resources!
Here is a relevant code snippet related to the "Host rejected with insufficient resources!" error message:
67: when "STATUS_ACCESS_DENIED"
68: vprint_error("Host reports access denied.")
69: when "STATUS_BAD_NETWORK_NAME"
70: vprint_error("Host is NOT connected to #{datastore['SMBDomain']}!")
71: when "STATUS_INSUFF_SERVER_RESOURCES"
72: vprint_error("Host rejected with insufficient resources!")
73: when "STATUS_OBJECT_NAME_INVALID"
74: vprint_error("opening \\#{path} bad filename")
75: else
76: raise e
77: end
opening \<PATH> bad filename
Here is a relevant code snippet related to the "opening \<PATH> bad filename" error message:
69: when "STATUS_BAD_NETWORK_NAME"
70: vprint_error("Host is NOT connected to #{datastore['SMBDomain']}!")
71: when "STATUS_INSUFF_SERVER_RESOURCES"
72: vprint_error("Host rejected with insufficient resources!")
73: when "STATUS_OBJECT_NAME_INVALID"
74: vprint_error("opening \\#{path} bad filename")
75: else
76: raise e
77: end
78: end
79: end
Host offline.
Here is a relevant code snippet related to the "Host offline." error message:
91:
92: datastore['RPATH'].each_line do |path|
93: check_path(path.chomp)
94: end #end do
95: rescue ::Rex::HostUnreachable
96: vprint_error("Host offline.")
97: rescue ::Rex::Proto::SMB::Exceptions::LoginError
98: print_error("Host login error.")
99: rescue ::Rex::ConnectionRefused
100: print_error "Unable to connect - connection refused"
101: rescue ::Rex::Proto::SMB::Exceptions::ErrorCode
Host login error.
Here is a relevant code snippet related to the "Host login error." error message:
93: check_path(path.chomp)
94: end #end do
95: rescue ::Rex::HostUnreachable
96: vprint_error("Host offline.")
97: rescue ::Rex::Proto::SMB::Exceptions::LoginError
98: print_error("Host login error.")
99: rescue ::Rex::ConnectionRefused
100: print_error "Unable to connect - connection refused"
101: rescue ::Rex::Proto::SMB::Exceptions::ErrorCode
102: print_error "Unable to connect to share #{datastore['SMBSHARE']}"
103: end # end begin
Unable to connect - connection refused
Here is a relevant code snippet related to the "Unable to connect - connection refused" error message:
95: rescue ::Rex::HostUnreachable
96: vprint_error("Host offline.")
97: rescue ::Rex::Proto::SMB::Exceptions::LoginError
98: print_error("Host login error.")
99: rescue ::Rex::ConnectionRefused
100: print_error "Unable to connect - connection refused"
101: rescue ::Rex::Proto::SMB::Exceptions::ErrorCode
102: print_error "Unable to connect to share #{datastore['SMBSHARE']}"
103: end # end begin
104: end # end def
105: end
Unable to connect to share <SMBSHARE>
Here is a relevant code snippet related to the "Unable to connect to share <SMBSHARE>" error message:
95: rescue ::Rex::HostUnreachable
96: vprint_error("Host offline.")
97: rescue ::Rex::Proto::SMB::Exceptions::LoginError
98: print_error("Host login error.")
99: rescue ::Rex::ConnectionRefused
100: print_error "Unable to connect - connection refused"
101: rescue ::Rex::Proto::SMB::Exceptions::ErrorCode
102: print_error "Unable to connect to share #{datastore['SMBSHARE']}"
103: end # end begin
104: end # end def
105: end
Go back to menu.
Related Pull Requests
- #13417 Merged Pull Request: SMBv3 integration with Framework
- #9189 Merged Pull Request: Change author name to nick.
- #8716 Merged Pull Request: Print_Status -> Print_Good (And OCD bits 'n bobs)
- #8338 Merged Pull Request: Fix msf/core and self.class msftidy warnings
- #6950 Merged Pull Request: Fix #6948, avoid printing rhost:rport twice when using Msf::Exploit::Remote::SMB::Client
- #6655 Merged Pull Request: use MetasploitModule as a class name
- #6648 Merged Pull Request: Change metasploit class names
- #4768 Merged Pull Request: Reorganize SMB mixins
- #2999 Merged Pull Request: altered check_dir_file.rb so that it can check for the presence of a lis...
- #2525 Merged Pull Request: Change module boilerplate
- #1228 Merged Pull Request: MSFTIDY cleanup #1 - auxiliary
Go back to menu.
See Also
Check also the following modules related to this module:
- exploit/multi/browser/adobe_flash_shader_drawing_fill
- exploit/unix/webapp/moinmoin_twikidraw
- exploit/windows/browser/viscom_movieplayer_drawtext
- exploit/windows/local/cve_2020_1054_drawiconex_lpe
- auxiliary/scanner/sap/sap_mgmt_con_instanceproperties
- exploit/linux/http/airties_login_cgi_bof
- exploit/windows/browser/symantec_consoleutilities_browseandsavefile
- post/firefox/gather/cookies
- post/multi/gather/chrome_cookies
- post/multi/sap/smdagent_get_properties
- encoder/x86/bmp_polyglot
- post/windows/gather/forensics/fanny_bmp_check
- auxiliary/admin/smb/delete_file
- auxiliary/admin/smb/download_file
- auxiliary/admin/smb/list_directory
- auxiliary/admin/smb/ms17_010_command
- auxiliary/admin/smb/psexec_ntdsgrab
- auxiliary/admin/smb/samba_symlink_traversal
- auxiliary/admin/smb/upload_file
- auxiliary/admin/smb/webexec_command
- post/multi/gather/check_malware
- auxiliary/admin/kerberos/ms14_068_kerberos_checksum
- auxiliary/gather/checkpoint_hostname
- auxiliary/scanner/oracle/tnspoison_checker
- auxiliary/scanner/rdp/ms12_020_check
- auxiliary/scanner/sap/sap_soap_rfc_pfl_check_os_file_existence
- auxiliary/scanner/vxworks/urgent11_check
Authors
- aushack
- j0hn__f
Version
This page has been produced using Metasploit Framework version 6.1.27-dev. For more modules, visit the Metasploit Module Library.
Go back to menu.
