Compare commits
8 Commits
0.1.0-rc-f
...
refactor-t
| Author | SHA1 | Date | |
|---|---|---|---|
276e99b893
|
|||
| bdbbf62d54 | |||
| 755e1d877b | |||
| 21d6d0a0d4 | |||
| a1df1e3972 | |||
| 96f653553f | |||
| 18b347368a | |||
| 4b9138d8f8 |
@@ -15,10 +15,10 @@ jobs:
|
||||
fetch-depth: 0
|
||||
- name: Increment tag
|
||||
id: tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@8d27605e8e6b2990e92e5aa75d703e602b8c4b2a # 0.1.28
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@41b7e04221df8a033bec841d40a097b76e5f67ff # 0.1.29
|
||||
with:
|
||||
token: ${{ secrets.GITEA_TOKEN }}
|
||||
- name: Push tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@8973a9f9ff51c16b937364e0047e7ad07e937d3f # 0.1.4
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@3925c92fc33f3d2bc87d28d21ab691b7e6dd6cdf # 0.2.1
|
||||
with:
|
||||
tag: ${{ steps.tag.outputs.new-tag }}
|
||||
|
||||
@@ -13,11 +13,11 @@ jobs:
|
||||
fetch-depth: 0
|
||||
- name: Increment tag
|
||||
id: tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@8d27605e8e6b2990e92e5aa75d703e602b8c4b2a # 0.1.28
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@41b7e04221df8a033bec841d40a097b76e5f67ff # 0.1.29
|
||||
with:
|
||||
token: ${{ secrets.GITEA_TOKEN }}
|
||||
prerelease: true
|
||||
- name: Push tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@8973a9f9ff51c16b937364e0047e7ad07e937d3f # 0.1.4
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@3925c92fc33f3d2bc87d28d21ab691b7e6dd6cdf # 0.2.1
|
||||
with:
|
||||
tag: ${{ steps.tag.outputs.new-tag }}
|
||||
|
||||
75
.gitea/workflows/run-sec-scan.yaml
Normal file
75
.gitea/workflows/run-sec-scan.yaml
Normal file
@@ -0,0 +1,75 @@
|
||||
name: Run Sec Scan
|
||||
|
||||
on:
|
||||
workflow_call:
|
||||
inputs:
|
||||
ecosystems:
|
||||
description: "Comma-separated ecosystems for setup-osv-db (see sec-actions/setup-osv-db)."
|
||||
required: false
|
||||
type: string
|
||||
default: "github-actions,npm,go,docker"
|
||||
cache-bucket-hours:
|
||||
description: "Cache key time bucket (hours) for setup-osv-db."
|
||||
required: false
|
||||
type: number
|
||||
default: 24
|
||||
osv-scanner-image:
|
||||
description: "Container image for OSV-Scanner (run with hardened docker options)."
|
||||
required: false
|
||||
type: string
|
||||
default: "ghcr.io/google/osv-scanner:latest"
|
||||
outputs:
|
||||
merged-sarif-artifact:
|
||||
description: "Artifact name containing the SARIF file (download this artifact; file inside is merged-sarif.json)."
|
||||
value: ${{ jobs.osv-scan.outputs.merged-sarif-artifact }}
|
||||
merged-sarif-path:
|
||||
description: "Path to the SARIF file inside the artifact (merged-sarif.json)."
|
||||
value: ${{ jobs.osv-scan.outputs.merged-sarif-path }}
|
||||
|
||||
jobs:
|
||||
osv-scan:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
merged-sarif-artifact: ${{ steps.meta.outputs.merged-sarif-artifact }}
|
||||
merged-sarif-path: ${{ steps.meta.outputs.merged-sarif-path }}
|
||||
steps:
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
|
||||
- name: Setup offline OSV DB
|
||||
id: setup-db
|
||||
uses: https://gitea.t000-n.de/t.behrendt/sec-actions/setup-osv-db@main
|
||||
with:
|
||||
ecosystems: ${{ inputs.ecosystems }}
|
||||
cache-bucket-hours: ${{ inputs.cache-bucket-hours }}
|
||||
|
||||
- name: Run OSV-Scanner in Docker (offline, no network, read-only)
|
||||
id: scan
|
||||
run: |
|
||||
set -euo pipefail
|
||||
SARIF_HOST_DIR="${RUNNER_TEMP}/osv-sarif-out"
|
||||
mkdir -p "${SARIF_HOST_DIR}"
|
||||
CACHE="${{ steps.setup-db.outputs.cache-dir }}"
|
||||
IMAGE="${{ inputs.osv-scanner-image }}"
|
||||
docker run --rm \
|
||||
--network none \
|
||||
--read-only \
|
||||
--tmpfs /tmp:rw,noexec,nosuid,size=256m \
|
||||
--cap-drop ALL \
|
||||
--security-opt no-new-privileges \
|
||||
-v "${GITHUB_WORKSPACE}:/work:ro" \
|
||||
-v "${CACHE}:/osv-db:ro" \
|
||||
-v "${SARIF_HOST_DIR}:/out" \
|
||||
-e OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY=/osv-db \
|
||||
"${IMAGE}" \
|
||||
scan source --offline-vulnerabilities --format sarif --output /out/merged-sarif.json -r /work
|
||||
|
||||
- name: Artifact metadata
|
||||
id: meta
|
||||
run: |
|
||||
echo "merged-sarif-artifact=merged-sarif" >> "$GITHUB_OUTPUT"
|
||||
echo "merged-sarif-path=merged-sarif.json" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- uses: https://github.com/ChristopherHX/gitea-upload-artifact@v4
|
||||
with:
|
||||
name: merged-sarif
|
||||
path: ${{ runner.temp }}/osv-sarif-out/merged-sarif.json
|
||||
86
README.md
86
README.md
@@ -1,2 +1,86 @@
|
||||
# trivy-workflows
|
||||
# Sec Workflows
|
||||
|
||||
## Run Sec Scan (reusable workflow)
|
||||
|
||||
Reusable workflow that restores the [OSV-Scanner](https://google.github.io/osv-scanner/) offline vulnerability database via **`setup-osv-db`**, runs **`osv-scanner scan source`** with **`--offline-vulnerabilities`**, and publishes a single SARIF artifact. It does **not** upload to TAS; callers download the artifact and use it (e.g. with `tas-upload-sarif`).
|
||||
|
||||
Scanning uses [Google OSV](https://osv.dev/) data (not Trivy). The scanner runs **only** inside Docker with **no container network**, a **read-only** root filesystem (plus a small **`tmpfs`** for `/tmp`), **all capabilities dropped**, and **`no-new-privileges`**. The workspace and the local OSV DB are bind-mounted **read-only**; SARIF is written to a dedicated host directory mounted read-write at `/out` in the container.
|
||||
|
||||
**Workflow file:** [.gitea/workflows/run-sec-scan.yaml](.gitea/workflows/run-sec-scan.yaml)
|
||||
|
||||
### Offline DB (`setup-osv-db`)
|
||||
|
||||
The workflow uses the **`setup-osv-db`** action from the **`sec-actions`** repository (replacing the former `trivy-actions` / `setup-trivy` flow). That action prepares `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` for use with `--offline-vulnerabilities` (see [OSV-Scanner offline mode](https://google.github.io/osv-scanner/usage/offline-mode/)).
|
||||
|
||||
## Usage
|
||||
|
||||
### Call from another workflow (same repo)
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
sec:
|
||||
uses: ./.gitea/workflows/run-sec-scan.yaml
|
||||
with:
|
||||
ecosystems: PyPI,npm,Go
|
||||
cache-bucket-hours: 6
|
||||
use-sarif:
|
||||
needs: sec
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Download SARIF
|
||||
uses: https://github.com/ChristopherHX/gitea-download-artifact@v4
|
||||
with:
|
||||
name: ${{ needs.sec.outputs.merged-sarif-artifact }}
|
||||
path: sarif
|
||||
# Path to file: sarif/${{ needs.sec.outputs.merged-sarif-path }}
|
||||
# - uses: .../tas-upload-sarif@...
|
||||
# with:
|
||||
# sarif-file: sarif/${{ needs.sec.outputs.merged-sarif-path }}
|
||||
```
|
||||
|
||||
### Call from another repository
|
||||
|
||||
Use the **full workflow path** including `.gitea/workflows/` and the filename. Gitea does not accept a bare repo path like `.../sec-actions/run-sec-scan@ref`.
|
||||
|
||||
**With absolute URL:**
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
sec:
|
||||
uses: https://gitea.t000-n.de/t.behrendt/sec-workflows/.gitea/workflows/run-sec-scan.yaml@1.0.0
|
||||
with:
|
||||
ecosystems: github-actions,npm,go,Alpine
|
||||
```
|
||||
|
||||
**With owner/repo path** (same server as the caller):
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
sec:
|
||||
uses: t.behrendt/sec-workflows/.gitea/workflows/run-sec-scan.yaml@1.0.0
|
||||
with:
|
||||
ecosystems: github-actions,npm,go,docker
|
||||
```
|
||||
|
||||
Pin the same tag or commit in `uses:` that you intend to run. Reusable actions referenced **inside** this workflow (for example `sec-actions/setup-osv-db`) are pinned in the workflow file; update that repo reference when you release new **sec-actions** versions.
|
||||
|
||||
### Inputs
|
||||
|
||||
| Input | Type | Default | Description |
|
||||
| --------------------- | ------ | ----------------------------------- | --------------------------------------------------------------------------- |
|
||||
| `ecosystems` | string | `github-actions,npm,go,docker` | Passed to **`setup-osv-db`** (`docker` maps to **Linux** in that action). |
|
||||
| `cache-bucket-hours` | number | `24` | Passed to **`setup-osv-db`** for `actions/cache` key bucketing. |
|
||||
| `osv-scanner-image` | string | `ghcr.io/google/osv-scanner:latest` | Image for the hardened **`docker run`** (offline scan; no network in run). Pin a digest or tag for reproducibility. |
|
||||
|
||||
### Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ----------------------- | ------------------------------------------------------------------- |
|
||||
| `merged-sarif-artifact` | Artifact name to pass to `download-artifact` (e.g. `merged-sarif`). |
|
||||
| `merged-sarif-path` | Path to the file inside that artifact (e.g. `merged-sarif.json`). |
|
||||
|
||||
After downloading the artifact, the SARIF file is at `<download-path>/${{ needs.<job>.outputs.merged-sarif-path }}`.
|
||||
|
||||
## Migration from Trivy
|
||||
|
||||
Earlier revisions used **Trivy** (`setup-trivy`, `setup-db` from **trivy-actions**) for config, filesystem, and image scans. This workflow now targets **OSV-Scanner** source scans with an **offline OSV database** only. Replacing IaC or container-image vulnerability semantics may require additional tooling outside this repository.
|
||||
|
||||
Reference in New Issue
Block a user