diff --git a/Dockerfile b/Dockerfile index e946f83..ad099ca 100644 --- a/Dockerfile +++ b/Dockerfile @@ -11,9 +11,9 @@ COPY assets /app/assets/ EXPOSE 8080 # Definir variable de entorno por defecto (puede sobreescribirse en K8s/OpenShift/Docker) -ENV HARBOR_URL="https://harbor.tu-dominio.com" -ENV HARBOR_ROBOT="admin" -ENV HARBOR_TOKEN="tu-token-super-secreto-aqui" +ENV HARBOR_URL="" +ENV HARBOR_ROBOT="" +ENV HARBOR_TOKEN="" # Ejecutar el proxy de Python CMD ["python3", "proxy-harbor.py"] diff --git a/README.md b/README.md index c84ef63..1e2ff59 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Portal de Seguridad Harbor (Inspector de CVEs y SBOMs) +# 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 (CVEs) y SBOMs en las instancias de Harbor corporativas, incluso trabajando detrás de estrictos firewalls. +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 @@ -9,11 +9,10 @@ La solución se divide en dos piezas clave para resolver las restricciones de re ### 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 y exportar (en formato CSV o JSON) las vulnerabilidades y artefactos detectados en Harbor. + * Permite buscar, filtrar y exportar (en formato CSV/Excel) las vulnerabilidades y artefactos detectados en Harbor. * Ofrece métricas rápidas clasificadas por severidad (Críticas, Altas, Medias y Bajas). - * Incluye un modal de configuración para introducir las credenciales de la API de Harbor de forma segura. - -Simplemente copia cualquiera de las dos versiones `harbor_security_local.html` o `harbor_security_portal.html` como `index.html` + +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. @@ -21,36 +20,170 @@ Simplemente copia cualquiera de las dos versiones `harbor_security_local.html` o * **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. +> +> Para optimizar la velocidad de acceso hace uso de la API `/security/vul`, aunque **necesita permisos de `administrador`** --- -## 🚀 Puesta en Marcha Rápida +## 🚀 Puesta en Marcha Rápida (*Local*) 1. Coloca el archivo `index.html` y el script `proxy-harbor.py` en la misma carpeta. -2. Arranca el servidor proxy con Python en tu terminal: -```bash - python3 proxy-harbor.py +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" ``` -Para mas detalles lee el [artículo de SoloConLinux](https://soloconlinux.org.es/expandiendo-harbor-con-un-panel-de-seguridad/) +> Este ajuste permite que los usuarios finales de la aplicación no necesiten conocer el `usuario/clave` de un usuario 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) --- -# Cambios - -Ahora es necesario usar una variable de entorno `HARBOR_URL` para definir la URL del servidor Harbor al que hay que conectarse. - - -Podeis usar una Demo de harbor en la web `https://demo.goharbor.io`, solamente teneis que crearos un usuario alli, luego definir la variable `HARBOR_URL="https://demo.goharbor.io"` ya sea como variable de entorno al iniciar el contenedor o antes de invocar al scripte de Python. +Para mas detalles lea el [artículo de SoloConLinux](https://soloconlinux.org.es/expandiendo-harbor-con-un-panel-de-seguridad/) -Desde vuestra consola simplemente escribis: +--- + -``` -HARBOR_URL="https://demo.goharbor.io" -python3 proxy-harbor.py -``` -Y luego os conectais a http://localhost:8080 diff --git a/capturas/hb-01.png b/capturas/hb-01.png new file mode 100644 index 0000000..18c221c Binary files /dev/null and b/capturas/hb-01.png differ diff --git a/capturas/hb-02.png b/capturas/hb-02.png new file mode 100644 index 0000000..10c1acc Binary files /dev/null and b/capturas/hb-02.png differ diff --git a/capturas/hb-03.png b/capturas/hb-03.png new file mode 100644 index 0000000..510efd6 Binary files /dev/null and b/capturas/hb-03.png differ diff --git a/capturas/hb-04.png b/capturas/hb-04.png new file mode 100644 index 0000000..7507952 Binary files /dev/null and b/capturas/hb-04.png differ diff --git a/capturas/hb-05.png b/capturas/hb-05.png new file mode 100644 index 0000000..237a1c7 Binary files /dev/null and b/capturas/hb-05.png differ diff --git a/capturas/hb-06.png b/capturas/hb-06.png new file mode 100644 index 0000000..ff887de Binary files /dev/null and b/capturas/hb-06.png differ diff --git a/capturas/hb-07.png b/capturas/hb-07.png new file mode 100644 index 0000000..d4efb13 Binary files /dev/null and b/capturas/hb-07.png differ diff --git a/docker-run.sh b/docker-run.sh deleted file mode 100644 index 4dbd94e..0000000 --- a/docker-run.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -docker run --env-file .env -p 8080:8080 harbor-security-portal diff --git a/env.yaml b/env.yaml index 02af257..bfa9a6a 100644 --- a/env.yaml +++ b/env.yaml @@ -14,7 +14,7 @@ spec: spec: containers: - name: proxy - image: tu-registry/harbor-vuln-portal:latest + image: tu-registry/harbor-security-portal:latest ports: - containerPort: 8080 env: @@ -25,7 +25,7 @@ spec: - name: HARBOR_TOKEN valueFrom: secretKeyRef: - name: harbor-robot-secret # Recomendado usar Secrets en K8s/OpenShift + name: harbor-robot-secret # Usar Secrets en K8s/OpenShift key: token diff --git a/fichero.env b/fichero.env index f580473..48601ca 100644 --- a/fichero.env +++ b/fichero.env @@ -1,4 +1,4 @@ -HARBOR_URL=https://harbor.tu-dominio.com -HARBOR_ROBOT=admin -HARBOR_TOKEN=tu-token-super-secreto-aqui +HARBOR_URL="https://harbor.tu-dominio.com" +HARBOR_ROBOT="admin" +HARBOR_TOKEN="tu-token-super-secreto-aqui" diff --git a/run-docker.sh b/run-docker.sh new file mode 100755 index 0000000..d346679 --- /dev/null +++ b/run-docker.sh @@ -0,0 +1,10 @@ +#!/bin/bash +echo "Iniciando contenedor portal-harbor" +echo "Conectese a: http://localhost:8080" +echo + +docker rm -f portal-harbor 2> /dev/null + +echo "Portal Harbor se iniciará en http://localhost:8080" +docker run -d -p 8080:8080 -e HARBOR_URL="https://harbor.tu-dominio.com" -e HARBOR_ROBOT="admin" -e HARBOR_TOKEN="tu-token" --name portal-harbor harbor-security-portal + diff --git a/run-docker_envfile.sh b/run-docker_envfile.sh new file mode 100755 index 0000000..dce14b7 --- /dev/null +++ b/run-docker_envfile.sh @@ -0,0 +1,9 @@ +#!/bin/bash +echo "Iniciando contenedor portal-harbor" +echo "Conectese a: http://localhost:8080" +echo + +docker rm -f portal-harbor 2> /dev/null + +echo "Portal Harbor se iniciará en http://localhost:8080" +docker run --env-file .env -p 8080:8080 --name portal-harbor harbor-security-portal diff --git a/run_local.sh b/run-local.sh old mode 100644 new mode 100755 similarity index 100% rename from run_local.sh rename to run-local.sh diff --git a/run_docker.sh b/run_docker.sh deleted file mode 100755 index bc7923e..0000000 --- a/run_docker.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/bash -docker rm -f portal-harbor 2> /dev/null -#docker run -d -p 8080:8080 -e HARBOR_URL="https://tu-harbor-corporativo.com" --name portal-harbor harbor-security-portal -docker run -d -p 8080:8080 -e HARBOR_URL="https://demo.goharbor.io" --name portal-harbor harbor-security-portal -echo "Portal Harbor iniciado en http://localhost:8080"