Compare commits
3 Commits
1.0.6
..
db1011147f
| Author | SHA1 | Date | |
|---|---|---|---|
|
db1011147f
|
|||
|
509ff6db09
|
|||
|
d746e98f30
|
@@ -10,15 +10,15 @@ jobs:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Increment tag
|
||||
id: tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@3ab82e6aa1db388a34562f5ce6eedb598651d916 # 0.1.42
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@8d27605e8e6b2990e92e5aa75d703e602b8c4b2a # 0.1.28
|
||||
with:
|
||||
token: ${{ secrets.GITEA_TOKEN }}
|
||||
- name: Push tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@7f9ed2bccd9161d124284619464c5dc5b15b79c0 # 0.2.11
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@8973a9f9ff51c16b937364e0047e7ad07e937d3f # 0.1.4
|
||||
with:
|
||||
tag: ${{ steps.tag.outputs.new-tag }}
|
||||
|
||||
+19
-41
@@ -4,57 +4,35 @@ on:
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
test-setup-osv:
|
||||
strategy:
|
||||
matrix:
|
||||
arch: [amd64, arm64]
|
||||
name: Test Setup OSV Scanner ${{ matrix.arch }}
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
- linux_${{ matrix.arch }}
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- name: Setup OSV Scanner
|
||||
uses: ./setup-osv
|
||||
with:
|
||||
version: v2.4.0
|
||||
amd64-digest: 15314940c10d26af9c6649f150b8a47c1262e8fc7e17b1d1029b0e479e8ed8a0
|
||||
arm64-digest: 44e580752910f0ff36ec99aff59af20f65df1e859aa31e5605a8f0d055b496e9
|
||||
- name: Run osv-scanner
|
||||
run: osv-scanner --version
|
||||
|
||||
test-setup-db:
|
||||
name: Test Setup DB
|
||||
test-setup-osv-db:
|
||||
name: Test Setup OSV offline DB
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- uses: ./setup-osv
|
||||
with:
|
||||
version: v2.4.0
|
||||
amd64-digest: 15314940c10d26af9c6649f150b8a47c1262e8fc7e17b1d1029b0e479e8ed8a0
|
||||
arm64-digest: 44e580752910f0ff36ec99aff59af20f65df1e859aa31e5605a8f0d055b496e9
|
||||
- name: Setup DB
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
- name: Setup offline DB
|
||||
id: setup-db
|
||||
uses: ./setup-db
|
||||
with:
|
||||
# Keep CI fast; full ecosystem download is covered by the action default.
|
||||
ecosystems: Go,npm,PyPI
|
||||
- name: Run osv-scanner offline
|
||||
uses: ./setup-osv-db
|
||||
- name: Verify DB zips exist
|
||||
shell: bash
|
||||
run: |
|
||||
test -n "${OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY}"
|
||||
test "${OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY}" = "${{ steps.setup-db.outputs.cache-dir }}"
|
||||
test -f "${OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY}/osv-scanner/Go/all.zip"
|
||||
test -f "${OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY}/osv-scanner/npm/all.zip"
|
||||
test -f "${OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY}/osv-scanner/PyPI/all.zip"
|
||||
osv-scanner scan source --offline-vulnerabilities --allow-no-lockfiles .
|
||||
set -euo pipefail
|
||||
root="${{ steps.setup-db.outputs.cache-dir }}/osv-scanner"
|
||||
[ -d "$root" ] || { echo "FAIL: missing directory $root"; exit 1; }
|
||||
n=0
|
||||
while IFS= read -r -d '' f; do
|
||||
[ -s "$f" ] || { echo "FAIL: empty or missing: $f"; exit 1; }
|
||||
n=$((n + 1))
|
||||
done < <(find "$root" -type f -name all.zip -print0)
|
||||
[ "$n" -ge 1 ] || { echo "FAIL: no all.zip under $root"; exit 1; }
|
||||
echo "OK: $n non-empty all.zip file(s) under $root"
|
||||
|
||||
test-get-images-from-files:
|
||||
name: Test Get Images From Files
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
- id: giff
|
||||
uses: ./get-images-from-files
|
||||
with:
|
||||
@@ -105,7 +83,7 @@ jobs:
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
|
||||
- name: Merge SARIF Files
|
||||
uses: ./merge-sarif-files
|
||||
with:
|
||||
|
||||
@@ -8,16 +8,16 @@ jobs:
|
||||
name: Prerelease
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
|
||||
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Increment tag
|
||||
id: tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@3ab82e6aa1db388a34562f5ce6eedb598651d916 # 0.1.42
|
||||
uses: https://gitea.t000-n.de/t.behrendt/conventional-semantic-git-tag-increment@8d27605e8e6b2990e92e5aa75d703e602b8c4b2a # 0.1.28
|
||||
with:
|
||||
token: ${{ secrets.GITEA_TOKEN }}
|
||||
prerelease: true
|
||||
- name: Push tag
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@7f9ed2bccd9161d124284619464c5dc5b15b79c0 # 0.2.11
|
||||
uses: https://gitea.t000-n.de/t.behrendt/actions/release-git-tag@8973a9f9ff51c16b937364e0047e7ad07e937d3f # 0.1.4
|
||||
with:
|
||||
tag: ${{ steps.tag.outputs.new-tag }}
|
||||
|
||||
@@ -1,3 +1,20 @@
|
||||
# OSV Scanner Actions
|
||||
# OSV-Scanner Actions
|
||||
|
||||
Gitea compatible actions related to osv-scanner or the OSV ecosystem.
|
||||
Gitea-compatible composite actions around [Google OSV-Scanner](https://github.com/google/osv-scanner): cache the offline vulnerability database, merge SARIF reports, and extract container image references from manifests. Install the `osv-scanner` CLI from [upstream releases](https://github.com/google/osv-scanner/releases) (or your package manager) in your workflow.
|
||||
|
||||
## Actions
|
||||
|
||||
| Directory | Purpose |
|
||||
| ---------------------- | ----------------------------------------------------------------------- |
|
||||
| `setup-osv-db` | Restore or populate selected ecosystem zips via curl; cache key includes hour bucket + ecosystem list. |
|
||||
| `merge-sarif-files` | Merge multiple SARIF files into one (tool-agnostic). |
|
||||
| `get-images-from-files`| Parse Dockerfiles, Kubernetes YAML, Compose, and Helmfile values for image refs (useful with `osv-scanner scan image …`). |
|
||||
|
||||
## Workflows
|
||||
|
||||
- **CI** (`.gitea/workflows/ci.yaml`): tests the actions above on `pull_request`.
|
||||
- **CD / Prerelease**: tag bump workflows unchanged (no scanner).
|
||||
|
||||
## Documentation
|
||||
|
||||
Each action directory has its own `README.md` with inputs, outputs, and examples.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Get Images From Files Action
|
||||
|
||||
A reusable Gitea Action that extracts Docker image references from selected files in a repository. Duplicate refs are deduplicated.
|
||||
A reusable Gitea Action that extracts Docker image references from selected files in a repository. Duplicate refs are deduplicated. Use the list with `osv-scanner scan image <ref>` (or a loop in CI) to scan container images.
|
||||
|
||||
**Note:** Only fully-qualified refs (with registry, e.g. `docker.io/library/alpine:latest`, `gcr.io/distroless/static:nonroot@sha256:...`) are included; short refs like `alpine:latest` are omitted as their use is discouraged.
|
||||
|
||||
@@ -21,7 +21,7 @@ Other files are supported if they use one of these patterns (e.g. `image:` or `F
|
||||
|
||||
```yaml
|
||||
- name: Get Images From Files
|
||||
uses: https://gitea.t000-n.de/t.behrendt/trivy-actions/get-images-from-files@0.0.1
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/get-images-from-files@0.0.1
|
||||
with:
|
||||
files: |
|
||||
- Dockerfile
|
||||
@@ -42,7 +42,7 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Get Images From Files
|
||||
uses: https://gitea.t000-n.de/t.behrendt/trivy-actions/get-images-from-files@0.0.1
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/get-images-from-files@0.0.1
|
||||
with:
|
||||
files: |
|
||||
- Dockerfile
|
||||
|
||||
@@ -10,7 +10,7 @@ A reusable Gitea Action that merges multiple SARIF files into a single SARIF fil
|
||||
|
||||
```yaml
|
||||
- name: Merge SARIF Files
|
||||
uses: https://gitea.t000-n.de/t.behrendt/trivy-actions/merge-sarif-files@0.0.1
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/merge-sarif-files@0.0.1
|
||||
with:
|
||||
files: |
|
||||
- test_sarif1.json
|
||||
@@ -30,7 +30,7 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Merge SARIF Files
|
||||
uses: https://gitea.t000-n.de/t.behrendt/trivy-actions/merge-sarif-files@0.0.1
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/merge-sarif-files@0.0.1
|
||||
with:
|
||||
files: |
|
||||
- test_sarif1.json
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
{
|
||||
"tool": {
|
||||
"driver": {
|
||||
"fullName": "Trivy Vulnerability Scanner",
|
||||
"informationUri": "https://github.com/aquasecurity/trivy",
|
||||
"name": "Trivy",
|
||||
"fullName": "OSV-Scanner",
|
||||
"informationUri": "https://github.com/google/osv-scanner",
|
||||
"name": "OSV-Scanner",
|
||||
"rules": [
|
||||
{
|
||||
"id": "KSV-0014",
|
||||
|
||||
@@ -5,9 +5,9 @@
|
||||
{
|
||||
"tool": {
|
||||
"driver": {
|
||||
"fullName": "Trivy Vulnerability Scanner",
|
||||
"informationUri": "https://github.com/aquasecurity/trivy",
|
||||
"name": "Trivy",
|
||||
"fullName": "OSV-Scanner",
|
||||
"informationUri": "https://github.com/google/osv-scanner",
|
||||
"name": "OSV-Scanner",
|
||||
"rules": [
|
||||
{
|
||||
"id": "CVE-2026-26019",
|
||||
|
||||
+8
-1
@@ -1,5 +1,12 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": ["local>t.behrendt/renovate-configs:action"],
|
||||
"extends": [
|
||||
"local>t.behrendt/renovate-configs:action"
|
||||
],
|
||||
"packageRules": [
|
||||
{
|
||||
"matchManagers": ["dockerfile", "kubernetes", "helmfile", "helm-values"],
|
||||
"ignorePaths": ["get-images-from-files/test*"]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,53 +0,0 @@
|
||||
# Setup DB Action
|
||||
|
||||
A reusable Gitea Action that sets up the osv-scanner offline vulnerability database, restoring from cache if available.
|
||||
|
||||
**Note:** This action only sets up the database. osv-scanner itself must be installed separately (e.g., using the `setup-osv` action). Subsequent steps receive `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` via the environment.
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```yaml
|
||||
- name: Setup DB
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/setup-db@0.0.1
|
||||
```
|
||||
|
||||
### Complete Example
|
||||
|
||||
```yaml
|
||||
name: Security Scan
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
- linux_amd64
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Setup OSV Scanner
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/setup-osv@0.0.1
|
||||
with:
|
||||
version: "v2.4.0"
|
||||
amd64-digest: "15314940c10d26af9c6649f150b8a47c1262e8fc7e17b1d1029b0e479e8ed8a0"
|
||||
arm64-digest: "44e580752910f0ff36ec99aff59af20f65df1e859aa31e5605a8f0d055b496e9"
|
||||
- name: Setup DB
|
||||
id: setup-db
|
||||
uses: https://gitea.t000-n.de/t.behrendt/osv-scanner-actions/setup-db@0.0.1
|
||||
- name: Scan for vulnerabilities
|
||||
run: osv-scanner scan source --offline-vulnerabilities -r .
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description | Required | Default |
|
||||
| ------------- | --------------------------------------------------------------------------- | -------- | -------------------------------- |
|
||||
| `cache-dir` | Path used as `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` | No | `${{ runner.temp }}/osv-scanner` |
|
||||
| `ecosystems` | Comma-separated OSV ecosystems to download; empty downloads all ecosystems | No | _(all)_ |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Output | Description |
|
||||
| ----------- | ------------------------------------------------ |
|
||||
| `cache-dir` | Path to the osv-scanner local DB cache directory |
|
||||
@@ -1,94 +0,0 @@
|
||||
name: "Setup OSV Scanner DB"
|
||||
description: "Setup the osv-scanner offline vulnerability database, restoring from cache if available"
|
||||
author: "Timo Behrendt <t.behrendt@t00n.de>"
|
||||
branding:
|
||||
icon: "database"
|
||||
color: "blue"
|
||||
|
||||
inputs:
|
||||
cache-dir:
|
||||
description: "Path used as OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY (default: ${{runner.temp}}/osv-scanner)"
|
||||
required: false
|
||||
default: "${{ runner.temp }}/osv-scanner"
|
||||
ecosystems:
|
||||
description: "Comma-separated list of OSV ecosystems to download. Empty downloads all ecosystems."
|
||||
required: false
|
||||
default: ""
|
||||
|
||||
outputs:
|
||||
cache-dir:
|
||||
description: "Path to the osv-scanner local DB cache directory"
|
||||
value: ${{ inputs.cache-dir }}
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- id: current-date
|
||||
shell: bash
|
||||
run: |
|
||||
echo "current-date=$(date +%Y-%m-%d)" >> $GITHUB_OUTPUT
|
||||
- id: restore-db
|
||||
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
|
||||
with:
|
||||
path: ${{ inputs.cache-dir }}
|
||||
key: osv-scanner-db-${{ steps.current-date.outputs.current-date }}
|
||||
restore-keys: |
|
||||
osv-scanner-db-${{ steps.current-date.outputs.current-date }}
|
||||
- name: Download offline databases
|
||||
if: steps.restore-db.outputs.cache-hit != 'true'
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
CACHE_DIR="${{ inputs.cache-dir }}"
|
||||
DB_DIR="${CACHE_DIR}/osv-scanner"
|
||||
mkdir -p "${DB_DIR}"
|
||||
|
||||
ECOSYSTEMS_INPUT="${{ inputs.ecosystems }}"
|
||||
if [ -n "${ECOSYSTEMS_INPUT}" ]; then
|
||||
# shellcheck disable=SC2001
|
||||
ECOSYSTEMS=$(echo "${ECOSYSTEMS_INPUT}" | tr ',' '\n' | sed 's/^[[:space:]]*//;s/[[:space:]]*$//' | grep -v '^$' || true)
|
||||
else
|
||||
ECOSYSTEMS=$(curl -fsSL https://osv-vulnerabilities.storage.googleapis.com/ecosystems.txt | grep -v '^$' | grep -v '^\[EMPTY\]$' || true)
|
||||
fi
|
||||
|
||||
if [ -z "${ECOSYSTEMS}" ]; then
|
||||
echo "No ecosystems to download" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
download_one() {
|
||||
local ecosystem="$1"
|
||||
local encoded
|
||||
encoded=$(printf '%s' "${ecosystem}" | jq -sRr @uri)
|
||||
local dest="${DB_DIR}/${ecosystem}"
|
||||
mkdir -p "${dest}"
|
||||
echo "Downloading ${ecosystem}..."
|
||||
curl -fsSL "https://osv-vulnerabilities.storage.googleapis.com/${encoded}/all.zip" -o "${dest}/all.zip"
|
||||
}
|
||||
|
||||
max_jobs=8
|
||||
pids=()
|
||||
while IFS= read -r ecosystem; do
|
||||
[ -z "${ecosystem}" ] && continue
|
||||
while [ "$(jobs -rp | wc -l)" -ge "${max_jobs}" ]; do
|
||||
sleep 0.2
|
||||
done
|
||||
download_one "${ecosystem}" &
|
||||
pids+=("$!")
|
||||
done <<< "${ECOSYSTEMS}"
|
||||
|
||||
fail=0
|
||||
for pid in "${pids[@]}"; do
|
||||
wait "${pid}" || fail=1
|
||||
done
|
||||
if [ "${fail}" -ne 0 ]; then
|
||||
echo "One or more ecosystem database downloads failed" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Downloaded $(find "${DB_DIR}" -name all.zip | wc -l) ecosystem database(s) to ${DB_DIR}"
|
||||
- name: Export DB cache directory
|
||||
shell: bash
|
||||
run: |
|
||||
echo "OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY=${{ inputs.cache-dir }}" >> "$GITHUB_ENV"
|
||||
@@ -0,0 +1,65 @@
|
||||
# Setup OSV offline DB Action
|
||||
|
||||
A reusable Gitea Action that restores or populates the [OSV-Scanner local vulnerability cache](https://google.github.io/osv-scanner/usage/offline-mode/) used with `--offline-vulnerabilities`.
|
||||
|
||||
Databases are fetched with **curl** from `https://osv-vulnerabilities.storage.googleapis.com/` as described under [Manual database download](https://google.github.io/osv-scanner/usage/offline-mode/#manual-database-download): for each requested ecosystem, download `…/<ecosystem>/all.zip` into `osv-scanner/<ecosystem>/all.zip`. **OSV-Scanner is not invoked** for downloads.
|
||||
|
||||
**Requires:** `curl`, `bash` 4+ (associative arrays), `python3` (URL-encoding paths).
|
||||
|
||||
**Note:** This action only prepares the local DB directory. Install the scanner separately.
|
||||
|
||||
## Ecosystems input
|
||||
|
||||
Use **`ecosystems`**: a comma-separated list (spaces around commas are trimmed). Each token is matched to an entry from [ecosystems.txt](https://osv-vulnerabilities.storage.googleapis.com/ecosystems.txt) by:
|
||||
|
||||
- **Slug match:** lowercased, spaces → `-`, brackets removed (e.g. `GitHub Actions` and `github-actions` both match).
|
||||
- **Special case:** `docker` is not an OSV ecosystem; it is treated as **`Linux`** (useful as a default when scanning image-related data). Override with `Alpine`, `Debian`, etc. if you prefer.
|
||||
|
||||
The **`actions/cache` key includes** the sorted, slugified list of resolved ecosystems (e.g. `github-actions,go,linux,npm`) plus the hour bucket settings, so different ecosystem sets never share a cache entry.
|
||||
|
||||
## Usage
|
||||
|
||||
```yaml
|
||||
uses: https://gitea.example/your-user/osv-scanner-actions/setup-osv-db@0.0.1
|
||||
with:
|
||||
ecosystems: PyPI,npm,Go
|
||||
```
|
||||
|
||||
## Example workflow
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
scan:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Setup offline DB
|
||||
id: setup-db
|
||||
uses: https://gitea.example/your-user/osv-scanner-actions/setup-osv-db@0.0.1
|
||||
with:
|
||||
cache-bucket-hours: 6
|
||||
ecosystems: github-actions,npm,go,Alpine
|
||||
- name: Scan (offline vulnerabilities only)
|
||||
env:
|
||||
OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY: ${{ steps.setup-db.outputs.cache-dir }}
|
||||
run: osv-scanner scan source --offline-vulnerabilities -r .
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
| Name | Description | Required | Default |
|
||||
| -------------------- | ------------------------------------------------------------------------- | -------- | -------------------------------- |
|
||||
| `cache-dir` | Directory for `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` | No | `${{ runner.temp }}/osv-scanner` |
|
||||
| `cache-bucket-hours` | `actions/cache` primary key includes `floor(UTC unix time / (3600 × N))`. | No | `24` |
|
||||
| `ecosystems` | Comma-separated tokens (names/slugs; `docker` → `Linux`). | No | `github-actions,npm,go,docker` |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Name | Description |
|
||||
| ----------- | ------------------ |
|
||||
| `cache-dir` | Same as input path |
|
||||
|
||||
## Behavior
|
||||
|
||||
- **Cache:** Key pattern `osv-scanner-db-{hours}h-eco-{sorted-slugs}-{bucket}`. `restore-keys` reuse the newest cache for the same hours + ecosystem set when the current time bucket misses.
|
||||
- **Populate:** On cache miss, `${cache-dir}/osv-scanner` is recreated and only the requested ecosystems are downloaded.
|
||||
@@ -0,0 +1,143 @@
|
||||
name: "Setup OSV offline vulnerability DB"
|
||||
description: "Populate or restore the OSV-Scanner local vulnerability database cache (offline mode)"
|
||||
author: "Timo Behrendt <t.behrendt@t00n.de>"
|
||||
branding:
|
||||
icon: "database"
|
||||
color: "blue"
|
||||
|
||||
inputs:
|
||||
cache-dir:
|
||||
description: "Directory for OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY (default: ${{ runner.temp }}/osv-scanner)"
|
||||
required: false
|
||||
default: "${{ runner.temp }}/osv-scanner"
|
||||
cache-bucket-hours:
|
||||
description: "actions/cache key advances every this many full hours (UTC, since epoch). Example: 24 ≈ daily bucket; 1 = new key each hour."
|
||||
required: false
|
||||
default: "24"
|
||||
ecosystems:
|
||||
description: "Comma-separated ecosystem tokens (slug or official name, see README). OSV has no Docker Hub bucket; token `docker` installs the `Linux` ecosystem as a practical default for image-style data."
|
||||
required: false
|
||||
default: "github-actions,npm,go,docker"
|
||||
|
||||
outputs:
|
||||
cache-dir:
|
||||
description: "Path passed to OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY"
|
||||
value: ${{ inputs.cache-dir }}
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- id: prepare
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
slugify() {
|
||||
local s="$1"
|
||||
s=$(printf '%s' "$s" | tr '[:upper:]' '[:lower:]')
|
||||
s=$(printf '%s' "$s" | sed 's/\[//g;s/\]//g')
|
||||
s=$(printf '%s' "$s" | sed 's/[[:space:]]\+/-/g')
|
||||
printf '%s' "$s"
|
||||
}
|
||||
|
||||
HOURS="${{ inputs.cache-bucket-hours }}"
|
||||
case "$HOURS" in
|
||||
''|*[!0-9]*) echo "cache-bucket-hours must be a positive integer, got: $HOURS" >&2; exit 1 ;;
|
||||
esac
|
||||
if [ "$HOURS" -lt 1 ]; then
|
||||
echo "cache-bucket-hours must be >= 1" >&2
|
||||
exit 1
|
||||
fi
|
||||
bucket=$(( $(date -u +%s) / (3600 * HOURS) ))
|
||||
echo "hours=$HOURS" >> "$GITHUB_OUTPUT"
|
||||
echo "bucket=$bucket" >> "$GITHUB_OUTPUT"
|
||||
|
||||
RUN_TEMP="${RUNNER_TEMP:-${{ runner.temp }}}"
|
||||
RESOLVED_FILE="${RUN_TEMP}/osv-db-ecosystems-resolved.txt"
|
||||
: > "$RESOLVED_FILE"
|
||||
|
||||
ecosystems_all="$(mktemp)"
|
||||
curl -fsSL "https://osv-vulnerabilities.storage.googleapis.com/ecosystems.txt" -o "$ecosystems_all"
|
||||
|
||||
declare -A SLUG_TO_OFFICIAL=()
|
||||
while IFS= read -r line || [ -n "$line" ]; do
|
||||
line="${line//$'\r'/}"
|
||||
[ -z "$line" ] && continue
|
||||
slug=$(slugify "$line")
|
||||
SLUG_TO_OFFICIAL["$slug"]="$line"
|
||||
done < "$ecosystems_all"
|
||||
rm -f "$ecosystems_all"
|
||||
|
||||
declare -A SEEN_CANONICAL=()
|
||||
INPUT="${{ inputs.ecosystems }}"
|
||||
INPUT="${INPUT//$'\r'/}"
|
||||
if [ -z "${INPUT//[[:space:]]/}" ]; then
|
||||
echo "ecosystems input is empty" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
IFS=',' read -ra PARTS <<< "$INPUT"
|
||||
for raw in "${PARTS[@]}"; do
|
||||
token=$(printf '%s' "$raw" | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
|
||||
[ -z "$token" ] && continue
|
||||
tslug=$(slugify "$token")
|
||||
if [ "$tslug" = "docker" ]; then
|
||||
official="Linux"
|
||||
elif [ -n "${SLUG_TO_OFFICIAL[$tslug]+x}" ]; then
|
||||
official="${SLUG_TO_OFFICIAL[$tslug]}"
|
||||
else
|
||||
echo "Unknown ecosystem token: ${token}. Valid names/slugs match https://osv-vulnerabilities.storage.googleapis.com/ecosystems.txt (token docker -> Linux)." >&2
|
||||
exit 1
|
||||
fi
|
||||
if [ -z "${SEEN_CANONICAL[$official]+x}" ]; then
|
||||
SEEN_CANONICAL[$official]=1
|
||||
printf '%s\n' "$official" >> "$RESOLVED_FILE"
|
||||
fi
|
||||
done
|
||||
|
||||
if [ ! -s "$RESOLVED_FILE" ]; then
|
||||
echo "No ecosystems resolved from input" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
slug_keys=()
|
||||
while IFS= read -r official || [ -n "$official" ]; do
|
||||
[ -z "$official" ] && continue
|
||||
slug_keys+=("$(slugify "$official")")
|
||||
done < "$RESOLVED_FILE"
|
||||
ecosystems_key=$(printf '%s\n' "${slug_keys[@]}" | sort -u | paste -sd, -)
|
||||
echo "ecosystems-key=$ecosystems_key" >> "$GITHUB_OUTPUT"
|
||||
- id: restore-db
|
||||
uses: actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306 # v5
|
||||
with:
|
||||
path: ${{ inputs.cache-dir }}
|
||||
key: osv-scanner-db-${{ steps.prepare.outputs.hours }}h-eco-${{ steps.prepare.outputs.ecosystems-key }}-${{ steps.prepare.outputs.bucket }}
|
||||
restore-keys: |
|
||||
osv-scanner-db-${{ steps.prepare.outputs.hours }}h-eco-${{ steps.prepare.outputs.ecosystems-key }}-
|
||||
- if: steps.restore-db.outputs.cache-hit != 'true'
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
CACHE_DIR="${{ inputs.cache-dir }}"
|
||||
ROOT="${CACHE_DIR}/osv-scanner"
|
||||
BASE="https://osv-vulnerabilities.storage.googleapis.com"
|
||||
RUN_TEMP="${RUNNER_TEMP:-${{ runner.temp }}}"
|
||||
RESOLVED_FILE="${RUN_TEMP}/osv-db-ecosystems-resolved.txt"
|
||||
|
||||
rm -rf "$ROOT"
|
||||
mkdir -p "$ROOT"
|
||||
|
||||
if [ ! -s "$RESOLVED_FILE" ]; then
|
||||
echo "Missing resolved ecosystem list at $RESOLVED_FILE" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
while IFS= read -r ecosystem || [ -n "$ecosystem" ]; do
|
||||
[ -z "$ecosystem" ] && continue
|
||||
enc="$(python3 -c "import urllib.parse,sys; print(urllib.parse.quote(sys.argv[1], safe=''))" "$ecosystem")"
|
||||
dest_dir="${ROOT}/${ecosystem}"
|
||||
mkdir -p "$dest_dir"
|
||||
tmp="$(mktemp)"
|
||||
curl -fsSL "${BASE}/${enc}/all.zip" -o "$tmp"
|
||||
mv "$tmp" "${dest_dir}/all.zip"
|
||||
done < "$RESOLVED_FILE"
|
||||
@@ -1,51 +0,0 @@
|
||||
# Setup OSV Scanner Action
|
||||
|
||||
A reusable Gitea Action that downloads and sets up the osv-scanner binary for vulnerability scanning.
|
||||
|
||||
The downloaded binary is verified against a pinned SHA-256 digest for the runner architecture.
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```yaml
|
||||
- name: Setup OSV Scanner
|
||||
uses: your-username/osv-scanner-actions@main/setup-osv
|
||||
with:
|
||||
version: "v2.4.0"
|
||||
amd64-digest: "15314940c10d26af9c6649f150b8a47c1262e8fc7e17b1d1029b0e479e8ed8a0"
|
||||
arm64-digest: "44e580752910f0ff36ec99aff59af20f65df1e859aa31e5605a8f0d055b496e9"
|
||||
```
|
||||
|
||||
Digests are published in each release's `osv-scanner_SHA256SUMS` file (e.g. for `osv-scanner_linux_amd64` / `osv-scanner_linux_arm64`). You may pass either bare hex or `sha256:<hex>`.
|
||||
|
||||
### Complete Example
|
||||
|
||||
```yaml
|
||||
name: Security Scan
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on:
|
||||
- ubuntu-latest
|
||||
- linux_amd64
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Setup OSV Scanner
|
||||
uses: your-username/osv-scanner-actions@main/setup-osv
|
||||
with:
|
||||
version: "v2.4.0"
|
||||
amd64-digest: "15314940c10d26af9c6649f150b8a47c1262e8fc7e17b1d1029b0e479e8ed8a0"
|
||||
arm64-digest: "44e580752910f0ff36ec99aff59af20f65df1e859aa31e5605a8f0d055b496e9"
|
||||
- name: Scan for vulnerabilities
|
||||
run: osv-scanner scan source -r .
|
||||
```
|
||||
|
||||
## Inputs
|
||||
|
||||
| Input | Description | Required | Default |
|
||||
| -------------- | -------------------------------------------------------------------- | -------- | ------- |
|
||||
| `version` | Explicit osv-scanner release tag (e.g. `v2.4.0`). `latest` is rejected | Yes | — |
|
||||
| `amd64-digest` | SHA-256 of `osv-scanner_linux_amd64` (hex or `sha256:<hex>`) | Yes | — |
|
||||
| `arm64-digest` | SHA-256 of `osv-scanner_linux_arm64` (hex or `sha256:<hex>`) | Yes | — |
|
||||
@@ -1,104 +0,0 @@
|
||||
name: "Setup OSV Scanner"
|
||||
description: "Download and setup osv-scanner binary for vulnerability scanning"
|
||||
author: "Gitea Actions"
|
||||
branding:
|
||||
icon: "shield"
|
||||
color: "blue"
|
||||
|
||||
inputs:
|
||||
version:
|
||||
description: "osv-scanner version to download (e.g., v2.4.0). Must be an explicit release tag; 'latest' is not allowed."
|
||||
required: true
|
||||
amd64-digest:
|
||||
description: "SHA-256 digest of the linux amd64 binary (hex or sha256:<hex>)"
|
||||
required: true
|
||||
arm64-digest:
|
||||
description: "SHA-256 digest of the linux arm64 binary (hex or sha256:<hex>)"
|
||||
required: true
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
steps:
|
||||
- name: Resolve architecture and digest
|
||||
shell: bash
|
||||
id: arch
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
VERSION="${{ inputs.version }}"
|
||||
if [ -z "${VERSION}" ] || [ "${VERSION}" = "latest" ]; then
|
||||
echo "version must be an explicit release tag (e.g. v2.4.0); 'latest' is not allowed" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
case "$(uname -m)" in
|
||||
x86_64)
|
||||
ARCH="amd64"
|
||||
DIGEST="${{ inputs.amd64-digest }}"
|
||||
;;
|
||||
aarch64)
|
||||
ARCH="arm64"
|
||||
DIGEST="${{ inputs.arm64-digest }}"
|
||||
;;
|
||||
*)
|
||||
echo "Unsupported architecture: $(uname -m)" >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
if [ -z "${DIGEST}" ]; then
|
||||
echo "Missing digest for architecture ${ARCH}" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Normalize sha256:<hex> / SHA256:<hex> to bare hex
|
||||
DIGEST="${DIGEST#sha256:}"
|
||||
DIGEST="${DIGEST#SHA256:}"
|
||||
|
||||
if ! [[ "${DIGEST}" =~ ^[a-fA-F0-9]{64}$ ]]; then
|
||||
echo "Invalid ${ARCH} digest (expected 64-char hex or sha256:<hex>): ${DIGEST}" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "ARCH=${ARCH}" >> "$GITHUB_OUTPUT"
|
||||
echo "DIGEST=${DIGEST}" >> "$GITHUB_OUTPUT"
|
||||
echo "VERSION=${VERSION}" >> "$GITHUB_OUTPUT"
|
||||
- name: Cache osv-scanner binary
|
||||
id: cache-osv
|
||||
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
|
||||
with:
|
||||
path: /usr/local/bin/osv-scanner
|
||||
key: osv-scanner-${{ steps.arch.outputs.version }}-${{ steps.arch.outputs.arch }}-${{ steps.arch.outputs.digest }}
|
||||
restore-keys: |
|
||||
osv-scanner-${{ steps.arch.outputs.version }}-${{ steps.arch.outputs.arch }}-${{ steps.arch.outputs.digest }}
|
||||
- name: Download and install osv-scanner
|
||||
if: steps.cache-osv.outputs.cache-hit != 'true'
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
VERSION="${{ steps.arch.outputs.version }}"
|
||||
ARCH="${{ steps.arch.outputs.arch }}"
|
||||
EXPECTED_DIGEST="${{ steps.arch.outputs.digest }}"
|
||||
DEST="/usr/local/bin/osv-scanner"
|
||||
|
||||
mkdir -p /usr/local/bin
|
||||
|
||||
curl -fsSL "https://github.com/google/osv-scanner/releases/download/${VERSION}/osv-scanner_linux_${ARCH}" -o "${DEST}"
|
||||
|
||||
ACTUAL_DIGEST=$(sha256sum "${DEST}" | awk '{print $1}')
|
||||
if [ "${ACTUAL_DIGEST}" != "${EXPECTED_DIGEST}" ]; then
|
||||
echo "Digest mismatch for osv-scanner ${VERSION} (linux_${ARCH})" >&2
|
||||
echo " expected: ${EXPECTED_DIGEST}" >&2
|
||||
echo " actual: ${ACTUAL_DIGEST}" >&2
|
||||
rm -f "${DEST}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
chmod +x "${DEST}"
|
||||
echo "Verified osv-scanner ${VERSION} (linux_${ARCH}) digest ${ACTUAL_DIGEST}"
|
||||
|
||||
- name: Add osv-scanner to PATH
|
||||
shell: bash
|
||||
run: |
|
||||
echo "/usr/local/bin" >> "$GITHUB_PATH"
|
||||
Reference in New Issue
Block a user