Metadata-Version: 2.4
Name: mvn-scan
Version: 1.7
Summary: Maven vulnerability scanner using OSS Index
Author-email: Edwin Geinner Castro Sepulveda <edwincastrose@gmail.com>
License-Expression: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4>=4.14.3
Requires-Dist: colorama>=0.4.6
Requires-Dist: Jinja2>=3.1.2
Requires-Dist: requests<3.0,>=2.28
Requires-Dist: tqdm>=4.66.2
Dynamic: license-file

# Maven Component Scanner

Escáner de vulnerabilidades para componentes Maven utilizando la API de OSS Index (Sonatype).

---

## 🚀 Descripción

**maven-component-scanner** es una herramienta de línea de comandos (CLI) que permite analizar dependencias de proyectos Maven y detectar vulnerabilidades conocidas (CVEs), utilizando la API de OSS Index de Sonatype.

Está diseñada para facilitar la identificación de riesgos de seguridad en componentes tanto directos como transitivos, generando reportes claros y detallados en formato HTML.

---

## 🔍 Funcionalidades

* Análisis de dependencias desde:

  * Archivos `.txt`
  * Archivos `.xml` (`pom.xml`)
  * Archivos `.war`
* Detección de vulnerabilidades (CVEs)
* Identificación de dependencias directas y transitivas
* Generación de reportes en HTML
* Integración con OSS Index (Sonatype)
* Configuración persistente de API Key

---

## 📦 Instalación

```bash
pip install maven-component-scanner
```

---

## ⚙️ Uso

```bash
mvn-scan -txt <archivo.txt> [-out <salida.html>]
mvn-scan -xml <archivo.xml> [-out <salida.html>]
mvn-scan -war <archivo.war> [-out <salida.html>]
```

---

## 🔑 Configuración de API Key

Esta herramienta requiere una API Key de OSS Index (Sonatype).

### Guardar API Key (recomendado)

```bash
mvn-scan --set-api-key TU_API_KEY
```

Esto almacenará la configuración en:

```
~/.mvnScan/config.json
```

---

### Uso con API Key directa

```bash
mvn-scan -txt deps.txt --api-key TU_API_KEY
```

---

## 🧪 Ejemplos

```bash
mvn-scan -txt deps.txt

mvn-scan -xml pom.xml -out report.html

mvn-scan -war file.war --api-key TU_API_KEY
```

---

## 📄 Reporte

El scanner genera un reporte HTML que incluye:

* Vulnerabilidades encontradas
* CVEs asociados
* Nivel de severidad
* Componentes afectados
* Dependencias directas y transitivas

---

## 🛠️ Requisitos

* Python >= 3.8
* API Key de OSS Index (obligatoria)

---

## 🌐 API utilizada

Este proyecto utiliza la API de OSS Index (Sonatype) para consultar vulnerabilidades de componentes.

Más información:
https://ossindex.sonatype.org/

---

## 📁 Estructura del proyecto

```
mvn_scan/
├── api_maven/
├── core/
├── helpers/
├── process_db/
├── cli.py
```

---

## 👨‍💻 Autor

**Edwin Geinner Castro Sepulveda**

GitHub:
https://github.com/Heiner

---

## 📜 Licencia

Este proyecto está bajo la licencia MIT.

Consulta el archivo LICENSE para más información.
