Metadata-Version: 2.4
Name: nmapvulners2csv
Version: 1.1.0
Summary: Convert Nmap Vulners script output to CSV
License: LICENSE
License-File: LICENSE
Author: SecSI
Author-email: dev@secsi.io
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
Requires-Dist: bs4 (>=0.0.1,<0.0.2)
Requires-Dist: elementpath (==4.1.5)
Requires-Dist: fire (==0.7.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: six (>=1.16.0,<2.0.0)
Requires-Dist: soupsieve (>=2.3.2.post1,<3.0.0)
Requires-Dist: termcolor (>=2.0.1,<3.0.0)
Description-Content-Type: text/markdown

<h1 align="center">
    <img src="https://raw.githubusercontent.com/cybersecsi/nmapvulners2csv/main/assets/logo-light-mode.png" alt= "nmapvulners2csv" width="300px">
</h1>

<p align="center">
    <b>nmapvulners2csv</b>
<p>


<p align="center">
  <a href="https://github.com/cybersecsi/nmapvulners2csv/blob/main/README.md"><img src="https://img.shields.io/badge/Documentation-complete-green.svg?style=flat"></a>
  <a href="https://github.com/cybersecsi/nmapvulners2csv/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache2-blue.svg"></a>
</p>

## Table of Contents
- [Getting Started](#getting-started)
  - [Install](#install)
  - [Run without installing](#run-without-installing)
    - [Prerequisites](#prerequisites)
  - [Evidences Description](#evidences-description)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)

##  Getting Started  
Run nmap with enabled script Vulners and save xml output, for example:   
```  
nmap -sV --script vulners -oX <nmap_output.xml>  
```  

### Example
The output of the tool is like the following:
![Execution example](https://github.com/cybersecsi/nmapvulners2csv/raw/main/assets/usage.png)

### Install & Run
To install it you just need to run:
```
pip install nmapvulners2csv
```

### Run without installing

#### Prerequisites   
Install dependencies by using the following command:   
``` 
pip install -r requirements.txt
chmod +x nmapvulners2csv/nmapvulners2csv.py
```

```   
Usage: nmapvulners2csv.py NMAP_XML_FILE <flags>
  optional flags:        --output | --descr
  
```  

To run the converter:   
```  
nmapvulners2csv.py <nmap_output.xml>   
``` 

the script will generate a file output.csv in output dir. If you want to set the output file:   
```   
nmapvulners2csv.py <nmap_output.xml>  --output <output_csv_file> --dir <output_directory>
``` 
For multiple data:   
```  
for i in `ls -1 vulners*`; do python nmapvulners2csv.py $i ${i%%.xml}.csv ; done   
``` 

### Evidences Description  
``nmapvulners2csv`` does not generate descriptions for vulnerabilities. You can add `--descr` flag to add descriptions in CSV.  The script scrapes description information from Vulners site. The command is more time-expensive and send several HTTP requests against Vulners website. Not tested for IP ban and network issues.     

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## Credits
``nmapvulners2csv`` is proudly developed [@SecSI](https://secsi.io) by:
- [Gaetano Perrone](https://github.com/giper45)
- [NdA994](https://github.com/NdA994)
- [Angelo Delicato](https://github.com/thelicato)

## License
Distributed under Apache 2 License. See `LICENSE` for more information. 
