Files
harbor-security/README.md
T

191 lines
6.2 KiB
Markdown

# Portal de Seguridad Harbor (Inspector Centralizado de Vulnerabilidades vía API)
Herramienta centralizada y offline-compatible diseñada para que el equipo de seguridad pueda auditar y consultar vulnerabilidades en las instancias de Harbor corporativas, incluso trabajando detrás de estrictos firewalls.
## 🛠️ Componentes del Sistema
La solución se divide en dos piezas clave para resolver las restricciones de red y de seguridad del navegador:
### 1. Interfaz Web Estática
* **Qué es:** Un panel de control moderno y responsivo basado en Tailwind CSS (optimizado para funcionar sin conexiones externas a CDNs).
* **Qué hace:**
* Permite buscar, filtrar las vulnerabilidades y artefactos detectados en Harbor.
* Permite exportar los elementos del filtro y página activa en formato CSV/Excel. *El límite de exportación son 100 elementos.*
* Ofrece métricas rápidas clasificadas por severidad (Críticas, Altas, Medias y Bajas).
El fichero encargado de todo esto es: `index.html`
### 2. Servidor Proxy Local (`proxy-harbor.py`)
* **Qué es:** Un script ligero desarrollado en Python (`http.server`) que actúa como pasarela local.
* **Qué hace:**
* **Bypasseo de CORS:** Evita que el navegador bloquee las peticiones web (*Same-Origin Policy* / errores `OPTIONS 405`) al servir la API de forma local.
* **Puente seguro:** Recibe las consultas de la interfaz web, les añade las cabeceras de Autenticación Básica necesarias y se comunica de manera transparente con la API REST v2.0 de Harbor mediante HTTPS.
* **Inyección de CORS:** Devuelve la respuesta en formato JSON limpia e incorpora automáticamente las cabeceras `Access-Control-Allow-Origin` permitiendo que la interfaz cargue los datos fluidamente.
* **Autenticación con la API:** Usando la configuración deseada se realiza una conexión a la API de Harbor.
> NOTA: Esta versión está diseñada para evitar recorrer de forma recursiva uno a uno los proyectos de Harbor y revisar las imágenes de los contenedores.
>
> Para optimizar la velocidad de acceso hace uso de la API `/security/vul`, aunque **necesita permisos de usuario `administrador` en Harbor**
---
## 🚀 Puesta en Marcha Rápida (*Local*)
1. Coloca el archivo `index.html` y el script `proxy-harbor.py` en la misma carpeta.
2. Para el correcto funcionamiento necesita tres variables:
```
HARBOR_URL="https://harbor.tu-dominio.com"
HARBOR_ROBOT="usuario-admin"
HARBOR_TOKEN="tu-token-super-secreto"
```
> Este ajuste permite que los usuarios finales de la aplicación no necesiten conocer el `usuario/clave` con rol de `admin`
Para probarlo contra un servidor Harbor, puedes crearte un usuario de prueba en: https://demo.goharbor.io
Por ejemplo, creamos el usuario: `security` y con clave/token: `S3cur1Ty`
3. Arranca el servidor proxy con Python escribiendo en tu terminal (todo en la misma línea):
```bash
HARBOR_URL="https://demo.goharbor.io" HARBOR_ROBOT="security" HARBOR_TOKEN="S3cur1Ty" python3 proxy-harbor.py
```
4. Conectate desde tu navegador a: http://localhost:8080
---
## Uso en Local/Docker/Kubernetes/Openshift
### Uso Local
Unicamente necesitas:
* Tener Python instalado en el equipo
* Seguir los pasos que hemos explicado en **Puesta en Marcha (Local)**
---
### Docker
Tan solo tienes que crear la imagen que contendrá Python, el script de python y el fichero html.
* **Construir la imagen:**
```
docker build --no-cache -t harbor-security-portal .
```
* **Iniciar el contenedor:**
Para funcionar correctamente el contenedor necesita las 3 variables que indicamos anteriormente
Esta variables se las puedes pasar desde la propia lína de comandos o dejar sus valores en un fichero `.env`
* **Uso con variables de entorno:** Debes iniciar el contenedor de la siguiente forma:
```
docker run -d -p 8080:8080 -e HARBOR_URL="https://harbor.tu-dominio.com" -e HARBOR_ROBOT="admin" -e HARBOR_TOKEN="tu-token" harbor-security-portal
```
* **Uso con fichero `.env`:** Debes de crear un fichero `.env` que tiene que tener el siguiente contenido:
```
HARBOR_URL="https://harbor.tu-dominio.com"
HARBOR_ROBOT="admin"
HARBOR_TOKEN="tu-token-super-secreto-aqui"
```
Para iniciarlo deberás escribir:
```
docker run --env-file .env -p 8080:8080 harbor-security-portal
```
Para ambos casos luego solo tienes que conectarte al puerto `8080` del equipo/servidor en que se esté ejecutando el contenedor.
---
### Kubernetes/Openshift
Para usarla en Kubernetes y/o Openshift tendremos los siguientes requisitos:
* Construir la imagen construida y subirla a un Registry al que pueda acceder K8/Openshift
* Definir las variables necesarias para iniciar el `Pod` en un *yaml* y el token guardarlo en un `secret`
Un ejemplo de `yaml` de la configuración podría ser:
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: harbor-vuln-portal
spec:
replicas: 1
selector:
matchLabels:
app: harbor-vuln-portal
template:
metadata:
labels:
app: harbor-vuln-portal
spec:
containers:
- name: proxy
image: tu-registry/harbor-security-portal:latest
ports:
- containerPort: 8080
env:
- name: HARBOR_URL
value: "https://harbor.tu-dominio.com"
- name: HARBOR_ROBOT
value: "usuario"
- name: HARBOR_TOKEN
valueFrom:
secretKeyRef:
name: harbor-robot-secret # Usar Secrets en K8s/OpenShift
key: token
```
---
## Capturas de la Aplicación
Algunas imágenes de la aplicación en funcionamiento.
* Se ha usado el servidor de demo de Harbor en https://demo.goharbor.io
* Se ha creado un usuario y clave con rol de `admin` para la conexión
* Se ha subido una `imagen de contenedor` para comprobar el funcionamiento real de la API
**Pantalla de Inicio. Conexión automática**
![](capturas/hb-01.png)
**Filtrado por `Severidad`**
![](capturas/hb-02.png)
**Filtrado por `CVE ID`**
![](capturas/hb-03.png)
**Filtrado por `Rango de CVSS3`**
![](capturas/hb-04.png)
**Filtrado por `Repositorio`**
![](capturas/hb-05.png)
**Filtrado por `Paquete`**
![](capturas/hb-06.png)
**Filtrado por `Digest`**
![](capturas/hb-07.png)
---
Para mas detalles lea el [artículo de SoloConLinux](https://soloconlinux.org.es/expandiendo-harbor-con-un-panel-de-seguridad/)
---