Active Inventory Generator:

Script designed to generate a report from the nmap execution results. Specifically, the information from the output in nmap XML format is filtered to dump the vulnerabilities found in the scanned network into an Excel file.

How to use:

Instalation:

Firstly, clone the repository in the /opt folder and change the owner of the downloaded folder. Then, you have to change to /opt/active-inventory-generator to continue the instalation. Before that, it is recommended to create a virtual environment for installing the script dependencies. A quick way to create a virtual environment can be to use the 'virtualenv' command. Example of use:

cd /opt
sudo git clone https://github.com/juanse77/active-inventory-generator
sudo chown [user]:[group] -R active-inventory-generator

python -m virtualenv .env

This will create a virtual environment in the '.env' subfolder. Next, the environment must be activated by executing the command:

source ./.env/bin/activate # in Linux

Next, you must install the script dependencies, executing:

python -m pip install -r requirements.txt

For complete installation, you need to edit the ~/.bashrc in shell bash or ~/.zshrc to add the application folder to the PATH. Insert this line to the file:

export PATH=$PATH:/opt/active-inventory-generator

You must run this command to activate the change if you just added the line. This will not be necessary on subsequent system reboots.

source ~/.bashrc # in shell bash
or
source ~/.zshrc # in shell zsh

With this initial configuration you are now ready to run the application.

Running the application:

Running the application is as simple as launching the python script by calling the interpreter and passing it an XML file with the results of an nmap scan. For example, as follows:

python active-inventory-generator.py scanned-network.xml excel-file-name.xlsx

Running with integrated Nmap:

You can also run the application through the 'extended-nmap.sh' script. This script will execute the nmap command and then the filter script for the xml document generated in the same execution. To do this you must give execution permissions to the script, and pass it the parameters that you want Nmap to take like input, followed by the name of the excel file that will be generated if all goes well.

sudo chmod +x extended-nmap.sh

# If you are in the application folder and/or the application folder is not in the PATH
./extended-nmap.sh "-Pn -sCV --script vuln --top-ports 100 -iL stored-ips" excel-file-name.xlsx

# If the application folder is in the PATH
extended-nmap.sh "-Pn -sCV --script vuln --top-ports 100 -iL stored-ips" excel-file-name.xlsx

Once the execution is complete, an excel file should have been generated in the same folder from where the script was executed.

New utilities added in version 2:

A shell bash script has been modified for sending alerts during the squential executing of nmap and the active inventory generator steps. During the progress of the execution messages to Slack and emails addresses will be sent.

How to use:

For it to work, is necesary to have a valid file with three environment vars: EMAIL_ADDRESS, EMAIL_PASSWORD, and WEB_HOOK. EMAIL_ADDRESS and EMAIL_PASSWORD, have to define a valid Gmail email and its application password of sixteen characters. The WEB_HOOK variable is an URL for the channel of Slack to be publicated. For the script to be excuted you need to pass the paramenters of the nmap that will be used, the name of the excel file that will be created, and the email or the list of emails you want to send the generated excel file. For example:

./extended-nmap.sh "-Pn -sCV --script vuln --top-ports 100 -iL stored-ips" excel-file-name.xlsx [email protected],[email protected],[email protected]

The environment variables will be read from a file called 'environment_vars.env'. An example of that file could be like this:

EMAIL_ADDRESS="[email protected]"
EMAIL_PASSWORD="emirhsalownernjk"
WEB_HOOK="https://hooks.slack.com/services/XXXXXX/XXXXXXXXXXXX" 

export EMAIL_ADDRESS
export EMAIL_PASSWORD
export WEB_HOOK

Deployment with Docker:

In the project folder there is a script called extended-nmap-docker.sh to run the application using a docker container. For which, you must first give it execution permissions.

sudo chmod +x extended-nmap-docker.sh

For this script to work, you must have the Docker application installed. When the script is executed, an image will be created, using the Dockerfile configuration file from the same project folder, and then a volatile container will be launched that will be responsible for executing the application.

The script accepts the same parameters as the extended-nmap.sh script, and if the PATH has been set correctly, it will work the same as the original script.

# If the application folder is in the PATH
extended-nmap-docker.sh "-Pn -sCV --script vuln --top-ports 100 -iL stored-ips" excel-file-name.xlsx [email protected],[email protected],[email protected]

License:

This project is licensed under the MIT License.

Contact:

For any questions or support, please contact [email protected].

Donate:

If you want to contribute to our initiative, please support us with a coffee ;D

© 2024 Active Inventory Generator for Nmap