xScan Introduction

This documentation provides an overview of the functionality of the thc_xs module.

xScan is a multi-host TCP/UDP port scanner that can scan port ranges or manually specified ports. xScan can also import results from the Shodown module.

Interface Parameters:

1. Ports: Select a port range or enter ports manually
2. Host: Target host or hosts separated by a comma
3. Scan Type: Select an action

ModGlue Variables:

1. $_CONTEXT['thc_xs']['datafile']: (string) Absolute path to the log file in the root of the module containing properties of performed scans
2. $_CONTEXT['thc_xs']['data_template']: (string) New template for scan sessions - only applies to the Remove File case
3. $_CONTEXT['thc_xs']['scan_results']: (array) Data from scan sessions - only applies to the Remove File case
4. $_CONTEXT['thc_xs']['queries']: (int) Number of sessions - only applies to the Remove File case
5. $_CONTEXT['thc_xs']['update']: (boolean) True if the file needs an update, false if not - only applies to the Remove File case
6. $_CONTEXT['thc_xs']['countnumber']: (int) Number of sessions in the data file - only applies to the Remove File case
7. $_CONTEXT['thc_xs']['scanresultfile']: (string) Absolute path to the results file in the module's results folder - only applies to the Remove File case
8. $_CONTEXT['thc_xs']['validfile']: (boolean) True if the specified file exists, false if invalid - only applies to the View File case
9. $_CONTEXT['thc_xs']['scan_properties']['ports']: (string) Ports open - only applies to the View File case
10. $_CONTEXT['thc_xs']['scan_properties']['domain']: (string) Type of host, IPv4/IPv6 - only applies to the View File case
11. $_CONTEXT['thc_xs']['scan_properties']['protocol']: (string) Type of scan, TCP/UDP - only applies to the View File case
12. $_CONTEXT['thc_xs']['scan_properties']['host']: (string) Host of the target - only applies to the View File case
13. $_CONTEXT['thc_xs']['scan_properties']['time']: (string) Timestamp when the session was performed - only applies to the View File case
14. $_CONTEXT['thc_xs']['hosts']: (array) Hosts to scan
15. $_CONTEXT['thc_xs']['socket']: (array) Data settings for sockets
16. $_CONTEXT['thc_xs']['scan_hosts']: (array) Settings for each scan
17. $_CONTEXT['thc_xs']['valid']: (int) Counter for valid hosts to scan
18. $_CONTEXT['thc_xs']['socket']['protocol_type']: (array) Settings for type of scan
19. $_CONTEXT['thc_xs']['scan_hosts_count']: (int) Number of valid hosts to scan
20. $_CONTEXT['thc_xs']['ports']: (array) Open port numbers
21. $_CONTEXT['thc_xs']['scan']['min']: (int) First port to scan in range
22. $_CONTEXT['thc_xs']['scan']['max']: (int) Last port to scan in range
23. $_CONTEXT['thc_xs']['portoptions']: (array) Port ranges
24. $_CONTEXT['thc_xs']['data_template_new']: (string) New data template for scan session properties
25. $_CONTEXT['thc_xs']['current_host']: (string) Current host being scanned
26. $_CONTEXT['thc_xs']['socket_create']: (resource) Socket connection pointer
27. $_CONTEXT['thc_xs']['open']: (int) Number of currently open ports
28. $_CONTEXT['thc_xs']['open_ports']: (array) Open ports on the current host
29. $_CONTEXT['thc_xs']['port']: (int) Current port to connect to during this iteration
30. $_CONTEXT['thc_xs']['socket_connect']: (resource) Socket connection to a specific port
31. $_CONTEXT['thc_xs']['filename']: (string) Name of the dynamically created result file stored in the module's results folder
32. $_CONTEXT['thc_xs']['fullfilename']: (string) Full path to the dynamically created result file stored in the module's results folder

Resource Settings:

• Time limit: PHP default
• Memory limit: PHP default

Dependencies:

Sockets

Expanding xScan:

N/A

Known Issues:

Results don't seem to work