Skip to content

Commit

Permalink
Merge pull request #81 from SwapneelM/patch-1
Browse files Browse the repository at this point in the history
Update process.rst
  • Loading branch information
savon-noir committed Nov 28, 2020
2 parents ab15bb7 + 63f55a2 commit ce38707
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,30 @@ Purpose of libnmap.process

The purpose of this module is to enable the lib users to launch and control nmap scans. This module will consequently fire the nmap command following the specified parameters provided in the constructor.

It is to note that this module will not perform a full inline parsing of the data. Only specific events are parsed and exploitable via either a callback function defined by the user and provided in the constructor; either by running the process in the background and accessing the NmapProcess attributes will the scan is running.
It is to note that this module will not perform a full inline parsing of the data. Only specific events are parsed and exploitable via either a callback function defined by the user and provided in the constructor or by running the process in the background and accessing the NmapProcess attributes while the scan is running.

To run an nmap scan, you need to:

- instanciate NmapProcess
- instantiate NmapProcess
- call the run*() methods

Raw results of the scans will be available in the following properties:

- NmapProcess.stdout: string, XML output
- NmapProcess.stderr: string, text error message from nmap process

To instanciate a NmapProcess instance, call the constructor with appropriate parameters
To instantiate an NmapProcess instance, call the constructor with the appropriate parameters

Processing of events
--------------------

While Nmap is running, some events are process and parsed. This would enable you to:
While Nmap is running, some events are processed and parsed. This would enable you to:

- evaluate estimated time to completion and progress in percentage
- find out which task is running and how many nmap task have been executed
- find out which task is running and how many nmap tasks have been executed
- know the start time and nmap version

As you may know, depending on the nmap options you specified, nmap will execute several tasks like "DNS Resolve", "Ping Scan", "Connect Scan", "NSE scripts",... This is of course independent from libnmap but the lib is able to parse these tasks and will instanciate a NmapTask object for any task executed. The list of executed task is available via the following properties:
As you may know, depending on the nmap options you specified, nmap will execute several tasks like "DNS Resolve", "Ping Scan", "Connect Scan", "NSE scripts",... This is of course independent from libnmap but the lib is able to parse these tasks and will instantiate a NmapTask object for any task executed. The list of executed task is available via the following properties:

- NmapProcess.tasks: list of NmapTask object (executed nmap tasks)
- NmapProcess.current_task: returns the currently running NmapTask
Expand Down

0 comments on commit ce38707

Please sign in to comment.