Constructor
new NmapWorker(options)
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object | Class options |
- Source:
Members
busy :Boolean
Indicates if a scan is currently running
Type:
- Boolean
- Source:
currentScan :Object
Scan options of the currently running scan
Type:
- Object
- Source:
customProfiles :Map
Stores custom profiles by name
Type:
- Map
- Source:
isWin :Boolean
Reference to the current OS
Type:
- Boolean
- Source:
(readonly) logDirectory :String
Path to save log files to, returns the temp directory if not specified
Type:
- String
- Source:
logExt :String
File extension for the log file
Type:
- String
- Source:
(readonly) logName :String
Name of the log file
Type:
- String
- Source:
nmapProcess :ChildProcess
Current nmap child process
Type:
- ChildProcess
- Source:
options :Object
Merge default options with given options
Type:
- Object
- Source:
profile
Changes current scan profile
- Source:
(readonly) profile
Current profile name getter
- Source:
(readonly) profileArgs
Get current nmap arguements by profile name, default profile is provided
if specified name is not found
- Source:
stderrBuffer :String
Nmap process std error buffer
Type:
- String
- Source:
stdoutBuffer :String
Nmap process std out buffer
Type:
- String
- Source:
Methods
addProfile(name, args)
Add custom scan profile
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | Scan profile name |
args |
String | Nmap arguments |
- Source:
killScan() → {Object}
Force quit current scan
- Source:
Returns:
The current scan options + the kill result
- Type
- Object
reset()
Clear no longer needed properties
- Source:
(async) scan(scanOptions)
Start a new scan
Parameters:
| Name | Type | Description |
|---|---|---|
scanOptions |
Object | Inlcude `target`, `profile` |
- Source: