
Ejecuta Trivy como acción de GitHub para escanear tu imagen de contenedor Docker en busca de vulnerabilidades
Descubre las herramientas más usadas por nuestra comunidad.
Sin datos de popularidad aún.
GitHub Action para Trivy
[![GitHub Release][release-img]][release] [![GitHub Marketplace][marketplace-img]][marketplace] [![License][license-img]][license]

name: build
on:
push:
branches:
- main
pull_request:
jobs:
build:
name: Build
runs-on: ubuntu-24.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Build an image from Dockerfile
run: docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
- name: Run Trivy vulnerability scanner
uses: aquasecurity/[email protected]
with:
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
format: 'table'
exit-code: '1'
ignore-unfixed: true
vuln-type: 'os,library'
severity: 'CRITICAL,HIGH'
name: build
on:
push:
branches:
- main
pull_request:
jobs:
build:
name: Build
runs-on: ubuntu-24.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run Trivy vulnerability scanner in fs mode
uses: aquasecurity/[email protected]
with:
scan-type: 'fs'
scan-ref: '.'
trivy-config: trivy.yaml
En este caso, trivy.yaml es una configuración YAML que se incluye como parte del repositorio. Hay información detallada disponible en el sitio web de Trivy, pero un ejemplo es el siguiente:
format: json
exit-code: 1
severity: CRITICAL
secret:
config: config/trivy/secret.yaml
Es posible definir todas las opciones en el archivo trivy.yaml. Especificar opciones individuales a través de la acción se mantiene por motivos de compatibilidad con versiones anteriores. Es necesario definir lo siguiente, ya que no puede definirse con el archivo de configuración:
scan-ref: Si se utilizan escaneos fs, repo.image-ref: Si se utiliza el escaneo image.scan-type: Para definir el tipo de escaneo, p. ej. image, fs, repo, etc.Trivy utiliza Viper, que tiene un orden de precedencia definido para las opciones. El orden es el siguiente:
La acción tiene una funcionalidad integrada para almacenar en caché y restaurar la base de datos de vulnerabilidades, la base de datos de Java y el paquete de checks si se descargan durante el escaneo.
La caché se almacena en el directorio $GITHUB_WORKSPACE/.cache/trivy de forma predeterminada.
La caché se restaura antes de que comience el escaneo y se guarda después de que finalice.
Utiliza actions/cache internamente, pero requiere menos ajustes de configuración. La entrada de caché es opcional y el almacenamiento en caché está activado de forma predeterminada.
Si deseas deshabilitar el almacenamiento en caché, establece la entrada cache en false, pero recomendamos mantenerlo habilitado para evitar problemas de limitación de tasa.
- name: Run Trivy scanner without cache
uses: aquasecurity/[email protected]
with:
scan-type: 'fs'
scan-ref: '.'
cache: 'false'
Ten en cuenta que existen restricciones en el acceso a la caché entre ramas en GitHub Actions.
De forma predeterminada, un flujo de trabajo puede acceder y restaurar una caché creada en la rama actual o en la rama predeterminada (normalmente main o master).
Si necesitas compartir cachés entre ramas, es posible que debas crear una caché en la rama predeterminada y restaurarla en la rama actual.
Para optimizar tu flujo de trabajo, puedes configurar un cron job para actualizar regularmente la caché en la rama predeterminada. Esto permite que los escaneos posteriores utilicen la base de datos en caché sin descargarla de nuevo.
# Note: This workflow only updates the cache. You should create a separate workflow for your actual Trivy scans.
# In your scan workflow, set TRIVY_SKIP_DB_UPDATE=true and TRIVY_SKIP_JAVA_DB_UPDATE=true.
name: Update Trivy Cache
on:
schedule:
- cron: '0 0 * * *' # Run daily at midnight UTC
workflow_dispatch: # Allow manual triggering
jobs:
update-trivy-db:
runs-on: ubuntu-latest
steps:
- name: Setup oras
uses: oras-project/setup-oras@v1
- name: Get current date
id: date
run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
- name: Download and extract the vulnerability DB
run: |
mkdir -p $GITHUB_WORKSPACE/.cache/trivy/db
oras pull ghcr.io/aquasecurity/trivy-db:2
tar -xzf db.tar.gz -C $GITHUB_WORKSPACE/.cache/trivy/db
rm db.tar.gz
- name: Download and extract the Java DB
run: |
mkdir -p $GITHUB_WORKSPACE/.cache/trivy/java-db
oras pull ghcr.io/aquasecurity/trivy-java-db:1
tar -xzf javadb.tar.gz -C $GITHUB_WORKSPACE/.cache/trivy/java-db
rm javadb.tar.gz
- name: Cache DBs
uses: actions/cache/save@v4
with:
path: ${{ github.workspace }}/.cache/trivy
key: cache-trivy-${{ steps.date.outputs.date }}
Al ejecutar un escaneo, establezca las variables de entorno TRIVY_SKIP_DB_UPDATE y TRIVY_SKIP_JAVA_DB_UPDATE para omitir el proceso de descarga.
- name: Run Trivy scanner without downloading DBs
uses: aquasecurity/[email protected]
with:
scan-type: 'image'
scan-ref: 'myimage'
env:
TRIVY_SKIP_DB_UPDATE: true
TRIVY_SKIP_JAVA_DB_UPDATE: true
Por defecto, la acción invoca aquasecurity/setup-trivy como primer paso,
lo que instala la versión de trivy especificada por la entrada version. Si ya ha instalado trivy por otros
medios, por ejemplo, invocando aquasecurity/setup-trivy directamente, o si está invocando esta acción varias veces, entonces puede usar la
entrada skip-setup-trivy para deshabilitar este paso.