Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
78d295d616 | ||
|
|
55b6b50672 | ||
|
|
e82c65a3c4 | ||
|
|
ade9877f07 | ||
|
|
371eedc0ef | ||
|
|
2656687937 | ||
|
|
6a93557620 | ||
|
|
632d2d7465 | ||
|
|
380988c194 | ||
|
|
a3c4ae5edf | ||
|
|
67a711fe3c | ||
|
|
9591a27e59 | ||
|
|
95abc7822e | ||
|
|
7fae1fa2f6 |
No files matched your search
@@ -0,0 +1,47 @@
|
||||
#!/usr/bin/env bash
|
||||
# Recompute the pinned SHA-256 of the Trivy and gitleaks release tarballs
|
||||
# after a version bump. Renovate runs it as a postUpgradeTask (tth/renovate
|
||||
# config.json), so a bump PR carries matching checksums; by hand:
|
||||
# bash .gitea/update-checksums.sh
|
||||
#
|
||||
# Each tarball is downloaded and hashed here, and the hash must ALSO match
|
||||
# the release's own checksums file - the pin is what we verified at bump
|
||||
# time, the action then refuses any other bytes.
|
||||
set -euo pipefail
|
||||
cd "$(dirname "$0")/.."
|
||||
work=$(mktemp -d)
|
||||
trap 'rm -rf "$work"' EXIT
|
||||
|
||||
# pin <action.yml> <version var> <repo> <name prefix> <arch suffix> <sha var>...
|
||||
pin() {
|
||||
local file=$1 vvar=$2 repo=$3 prefix=$4
|
||||
shift 4
|
||||
local ver
|
||||
ver=$(sed -n "s/^ *$vvar: *\"\([0-9.]*\)\".*/\1/p" "$file")
|
||||
[ -n "$ver" ] || {
|
||||
echo "no $vvar in $file" >&2
|
||||
exit 1
|
||||
}
|
||||
local base="https://github.com/$repo/releases/download/v$ver"
|
||||
curl -fsSL --retry 3 -o "$work/sums" "$base/${prefix}_${ver}_checksums.txt"
|
||||
while [ "$#" -gt 0 ]; do
|
||||
local arch=$1 svar=$2
|
||||
shift 2
|
||||
local tgz="${prefix}_${ver}_${arch}.tar.gz"
|
||||
curl -fsSL --retry 3 -o "$work/$tgz" "$base/$tgz"
|
||||
local got want
|
||||
got=$(sha256sum "$work/$tgz" | cut -d' ' -f1)
|
||||
want=$(awk -v f="$tgz" '$2 == f {print $1}' "$work/sums")
|
||||
[ "$got" = "$want" ] || {
|
||||
echo "$tgz: downloaded $got, release says ${want:-nothing}" >&2
|
||||
exit 1
|
||||
}
|
||||
sed -i "s/^\( *$svar: *\)[0-9a-f]\{64\}/\1$got/" "$file"
|
||||
echo "$tgz $got"
|
||||
done
|
||||
}
|
||||
|
||||
pin trivy-gate/action.yml TRIVY_VERSION aquasecurity/trivy trivy \
|
||||
Linux-64bit TRIVY_SHA256_AMD64 Linux-ARM64 TRIVY_SHA256_ARM64
|
||||
pin gitleaks/action.yml GITLEAKS_VERSION gitleaks/gitleaks gitleaks \
|
||||
linux_x64 GITLEAKS_SHA256_X64 linux_arm64 GITLEAKS_SHA256_ARM64
|
||||
@@ -0,0 +1,58 @@
|
||||
# PR check (Renovate bumps of Trivy / gitleaks, and any other PR): the
|
||||
# actions of THIS branch must actually run. Both runtimes of trivy-gate:
|
||||
# the Trivy container (docker job) and the pinned binary with its checksum
|
||||
# check (container job without Docker) - a bump with a wrong checksum fails
|
||||
# here, not in every pipeline that uses the next tag. Required by branch
|
||||
# protection, so a green PR automerges and tag.yml cuts the next vN.
|
||||
name: pr-check
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
concurrency:
|
||||
group: pr-check-${{ github.head_ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: trivy-gate, Trivy container, image scan
|
||||
id: image
|
||||
uses: ./trivy-gate
|
||||
with:
|
||||
image: alpine:3.22@sha256:2e0b81d60597f449baa56dc25d355367869d2dca4cd57e866f1e2b52af3eb55f
|
||||
runtime: docker
|
||||
mode: warn
|
||||
- name: The report is real
|
||||
run: |
|
||||
set -euo pipefail
|
||||
jq -e '.Results | length > 0' "${{ steps.image.outputs.report }}" >/dev/null
|
||||
echo "blocking=${{ steps.image.outputs.blocking }}"
|
||||
- name: gitleaks
|
||||
uses: ./gitleaks
|
||||
with:
|
||||
mode: block
|
||||
|
||||
binary:
|
||||
runs-on: ubuntu-latest
|
||||
# No Docker CLI here, so trivy-gate falls back to the pinned binary.
|
||||
container:
|
||||
image: node:26-trixie-slim@sha256:36793bcbb160a6a16cede1e62b93f84e26b78a972a8a4c0b879c1c12f22761ec
|
||||
steps:
|
||||
- name: Tools the actions expect
|
||||
run: apt-get update -qq && apt-get install -y -qq --no-install-recommends ca-certificates curl git jq >/dev/null
|
||||
- uses: actions/checkout@v7
|
||||
- name: trivy-gate, pinned binary, fs scan
|
||||
id: fs
|
||||
uses: ./trivy-gate
|
||||
with:
|
||||
scan-type: fs
|
||||
runtime: binary
|
||||
mode: warn
|
||||
- name: The report is real
|
||||
run: jq -e 'has("Results") or has("ArtifactName")' "${{ steps.fs.outputs.report }}" >/dev/null
|
||||
- name: gitleaks, pinned binary
|
||||
uses: ./gitleaks
|
||||
with:
|
||||
mode: block
|
||||
@@ -0,0 +1,31 @@
|
||||
# Cut the next major tag (vN) when a Renovate bump of a pinned tool lands on
|
||||
# main, so the pipelines get it through their own Renovate PR ("update
|
||||
# ci-actions to vN"). Only renovate-bot's merges: hand-made changes keep
|
||||
# being tagged by hand, with the README note.
|
||||
name: tag
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
tag:
|
||||
if: github.actor == 'renovate-bot'
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Next vN on HEAD
|
||||
run: |
|
||||
set -euo pipefail
|
||||
git fetch -q --tags
|
||||
if git tag --points-at HEAD | grep -qE '^v[0-9]+$'; then
|
||||
echo "HEAD already tagged: $(git tag --points-at HEAD | tr '\n' ' ')"; exit 0
|
||||
fi
|
||||
last=$(git tag -l 'v[0-9]*' | grep -E '^v[0-9]+$' | sed 's/^v//' | sort -n | tail -1)
|
||||
next="v$((${last:-0} + 1))"
|
||||
git tag "$next" HEAD
|
||||
git push origin "refs/tags/$next"
|
||||
echo "tagged $next on $(git rev-parse --short HEAD): $(git log -1 --format=%s)"
|
||||
@@ -27,6 +27,20 @@ Intended order in a pipeline:
|
||||
skip: ${{ inputs.skip_trivy || 'false' }}
|
||||
```
|
||||
|
||||
Source trees (apps that ship no image, e.g. an APK): `scan-type: fs` scans
|
||||
the git-tracked files plus lockfiles generated in the job (also gitignored
|
||||
ones like Flutter's `pubspec.lock`), so run it after the dependency fetch:
|
||||
|
||||
```yaml
|
||||
- uses: https://git.rfa.cz/tth-pub/ci-actions/trivy-gate@v2
|
||||
with:
|
||||
scan-type: fs
|
||||
```
|
||||
|
||||
Jobs without a Docker daemon (a `container:` image such as Flutter) fall
|
||||
back to the pinned Trivy release binary, verified by SHA-256 (`runtime:
|
||||
auto`); `jq` is installed with apt when missing.
|
||||
|
||||
Accepted risks go to `.trivyignore.yaml` in the calling repo, each with a
|
||||
statement and an expiry, so they come back on their own:
|
||||
|
||||
@@ -56,3 +70,92 @@ Dependency-Track. Never fails the job.
|
||||
project: my-image
|
||||
version: latest
|
||||
```
|
||||
|
||||
## trivy-gate: misconfigurations
|
||||
|
||||
`scanners: misconfig` with `scan-type: fs` checks Dockerfiles, compose and
|
||||
other IaC in the tree. These findings are reported (HIGH/CRITICAL by
|
||||
default) and never block.
|
||||
|
||||
```yaml
|
||||
- uses: https://git.rfa.cz/tth-pub/ci-actions/trivy-gate@v2
|
||||
with:
|
||||
scan-type: fs
|
||||
scanners: misconfig
|
||||
mode: warn
|
||||
```
|
||||
|
||||
## gitleaks
|
||||
|
||||
Scans the commits of the push (`before..sha`, first-parent line, merge diffs
|
||||
off, so merging upstream into a fork does not report upstream history) for
|
||||
secrets, with redacted output. Without a `.gitleaks.toml` in the repo the
|
||||
default rules apply with test files and fixtures allowlisted. The release
|
||||
binary is verified by SHA-256.
|
||||
|
||||
```yaml
|
||||
- uses: https://git.rfa.cz/tth-pub/ci-actions/gitleaks@v2
|
||||
with:
|
||||
mode: block # or warn
|
||||
```
|
||||
|
||||
## Versions
|
||||
|
||||
`v1` image gate + SBOM; `v2` fs scans, binary runtime, misconfig, gitleaks;
|
||||
`v3` gitleaks fetches the parent of a single commit in a depth-1 checkout
|
||||
(dispatch/cron runs scanned the whole tree as a root commit before).
|
||||
`v8` dtrack-sbom really never fails the job: the runner's `bash -e` turned
|
||||
an unreachable Dependency-Track into a failed build instead of a warning.
|
||||
|
||||
Pinned tools (Trivy binary + image, gitleaks) are bumped by Renovate
|
||||
(tth/renovate). Its post-upgrade task `.gitea/update-checksums.sh`
|
||||
recomputes the tarball SHA-256 pins (downloaded and checked against the
|
||||
release's checksums file); `.gitea/workflows/pr-check.yml` runs the actions
|
||||
of the PR branch with both Trivy runtimes; after the merge `tag.yml` cuts
|
||||
the next `vN`, which the pipelines then pick up through their own Renovate
|
||||
PR. Hand-made changes are tagged by hand as before.
|
||||
|
||||
## portainer-deploy
|
||||
|
||||
Updates a Portainer Swarm stack from a compose file in the repository - the
|
||||
last step of the build → `trivy-gate` → move `latest` → deploy pipeline. The
|
||||
compose file in git is the single source of truth: Portainer's stored
|
||||
compose is replaced on every deploy. The stack's env vars (where the secrets
|
||||
live) are kept and never logged; only `vars` are overwritten. Images are
|
||||
re-pulled (`pullImage`).
|
||||
|
||||
```yaml
|
||||
- uses: https://git.rfa.cz/tth-pub/ci-actions/portainer-deploy@v5
|
||||
with:
|
||||
url: ${{ secrets.PORTAINER_URL }}
|
||||
token: ${{ secrets.PORTAINER_TOKEN }}
|
||||
stack-id: ${{ secrets.PORTAINER_STACK_ID }} # empty = skip with a notice
|
||||
compose-file: docker-compose.swarm.yml
|
||||
vars: |
|
||||
IMAGE_TAG=sha-${{ steps.build.outputs.sha }}
|
||||
smoke-url: https://app.example.org/health # optional
|
||||
smoke-status: "200"
|
||||
smoke-timeout: "180"
|
||||
```
|
||||
|
||||
Config files from the repo can ride along as Swarm configs. Each becomes a
|
||||
config named after its content hash, created when missing; the stack
|
||||
variable points at it, so a changed file rolls the services that mount it,
|
||||
and superseded versions are removed once nothing uses them:
|
||||
|
||||
```yaml
|
||||
configs: |
|
||||
CFG_NGINX=deploy/nginx.conf
|
||||
config-prefix: myapp_
|
||||
```
|
||||
|
||||
```yaml
|
||||
# compose
|
||||
configs:
|
||||
nginx_conf: {external: true, name: "${CFG_NGINX}"}
|
||||
```
|
||||
|
||||
Pin images in the compose file to the variable (`image: …:${IMAGE_TAG}`), so
|
||||
the deployed version is the commit that passed the gate, not whatever
|
||||
`latest` points at when Swarm pulls.
|
||||
|
||||
+20
-6
@@ -32,7 +32,7 @@ inputs:
|
||||
default: "5"
|
||||
trivy-image:
|
||||
description: Trivy container image, pinned by digest.
|
||||
default: aquasec/trivy:0.75.0@sha256:af6acf9a6b85dfe389a1941505c0ce9efef52a4719635e1a962f022a3d855daa
|
||||
default: aquasec/trivy:0.76.1@sha256:790fd66d1697395d8693d1acaa1ea702406a20f109b6fc7bac8db623eca6c06c
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
@@ -49,17 +49,31 @@ runs:
|
||||
MIN: ${{ inputs.min-components }}
|
||||
TRIVY: ${{ inputs.trivy-image }}
|
||||
run: |
|
||||
set -uo pipefail
|
||||
# The runner starts composite bash steps with -e; this script handles
|
||||
# every failure itself (warn, exit 0), so -e only turns an unguarded
|
||||
# command into a failed job - e.g. the cat of a resp.json curl never
|
||||
# wrote when Dependency-Track was unreachable.
|
||||
set +e -uo pipefail
|
||||
warn() { echo "::warning::SBOM $PROJECT/$VERSION: $*"; exit 0; }
|
||||
[ -n "$REPORT" ] && [ -f "$REPORT" ] || warn "no report (gate skipped?)"
|
||||
[ -n "$DT_KEY" ] || warn "no API key"
|
||||
work="${RUNNER_TEMP:-/tmp}/dtrack-sbom"; mkdir -p "$work"
|
||||
docker run -i --rm --entrypoint sh "$TRIVY" -c \
|
||||
'cat >/tmp/r.json && trivy convert --quiet --format cyclonedx /tmp/r.json' \
|
||||
<"$REPORT" >"$work/bom.json" || warn "trivy convert failed"
|
||||
# Same runtime as trivy-gate: its container when a Docker daemon is
|
||||
# reachable, else the checksum-verified binary trivy-gate fetched.
|
||||
gate_bin="${RUNNER_TEMP:-/tmp}/trivy-gate/bin/trivy"
|
||||
if command -v docker >/dev/null && docker info >/dev/null 2>&1; then
|
||||
docker run -i --rm --entrypoint sh "$TRIVY" -c \
|
||||
'cat >/tmp/r.json && trivy convert --quiet --format cyclonedx /tmp/r.json' \
|
||||
<"$REPORT" >"$work/bom.json" || warn "trivy convert failed"
|
||||
elif [ -x "$gate_bin" ]; then
|
||||
"$gate_bin" convert --quiet --format cyclonedx "$REPORT" >"$work/bom.json" || warn "trivy convert failed"
|
||||
else
|
||||
warn "neither Docker nor the trivy-gate binary available"
|
||||
fi
|
||||
if [ -n "$EXTRA" ]; then
|
||||
jq --slurpfile extra "$EXTRA" '.components += $extra[0]' "$work/bom.json" >"$work/bom2.json" \
|
||||
&& mv "$work/bom2.json" "$work/bom.json" || warn "cannot merge $EXTRA"
|
||||
|| warn "cannot merge $EXTRA"
|
||||
mv "$work/bom2.json" "$work/bom.json"
|
||||
fi
|
||||
n=$(jq '.components | length' "$work/bom.json") || warn "unreadable SBOM"
|
||||
[ "$n" -ge "$MIN" ] || warn "only $n components, not uploading"
|
||||
|
||||
@@ -0,0 +1,133 @@
|
||||
name: gitleaks
|
||||
description: >
|
||||
Scan the commits a push brings for secrets with gitleaks. Only the
|
||||
first-parent line is scanned, so a merge of upstream into a fork reports
|
||||
our commits, not the upstream history. Findings are always redacted.
|
||||
|
||||
inputs:
|
||||
mode:
|
||||
description: "block = fail the step on findings, warn = report only."
|
||||
default: block
|
||||
log-opts:
|
||||
description: >
|
||||
git log range/options passed to gitleaks. Empty = the commits of this
|
||||
push (before..sha) on the first-parent line, else the last commit.
|
||||
default: ""
|
||||
config:
|
||||
description: >
|
||||
gitleaks config in the repo (allowlists); used when it exists. Without
|
||||
one, the default rules apply with test files allowlisted (fixtures
|
||||
carry fake keys by design and the noise would bury a real one).
|
||||
default: .gitleaks.toml
|
||||
skip:
|
||||
description: Emergency bypass (workflow_dispatch input); logged loudly.
|
||||
default: "false"
|
||||
|
||||
outputs:
|
||||
findings:
|
||||
description: Number of findings.
|
||||
value: ${{ steps.scan.outputs.findings }}
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- id: scan
|
||||
shell: bash
|
||||
env:
|
||||
MODE: ${{ inputs.mode }}
|
||||
LOG_OPTS: ${{ inputs.log-opts }}
|
||||
CONFIG: ${{ inputs.config }}
|
||||
SKIP: ${{ inputs.skip }}
|
||||
BEFORE: ${{ github.event.before }}
|
||||
SHA: ${{ github.sha }}
|
||||
GITLEAKS_VERSION: "8.30.1"
|
||||
GITLEAKS_SHA256_X64: 551f6fc83ea457d62a0d98237cbad105af8d557003051f41f3e7ca7b3f2470eb
|
||||
GITLEAKS_SHA256_ARM64: e4a487ee7ccd7d3a7f7ec08657610aa3606637dab924210b3aee62570fb4b080
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [ "$SKIP" = "true" ]; then
|
||||
echo "::warning::GITLEAKS SKIPPED (manual bypass)"; echo "findings=0" >>"$GITHUB_OUTPUT"; exit 0
|
||||
fi
|
||||
case "$MODE" in block|warn) ;; *) echo "::error::mode must be block or warn"; exit 1 ;; esac
|
||||
work="${RUNNER_TEMP:-/tmp}/gitleaks"; mkdir -p "$work"
|
||||
if ! command -v jq >/dev/null; then
|
||||
(apt-get update -qq && apt-get install -y -qq jq) >/dev/null 2>&1 || { echo "::error::jq is required"; exit 1; }
|
||||
fi
|
||||
git config --global --add safe.directory "$PWD" 2>/dev/null || true
|
||||
|
||||
# Release binary, verified by SHA-256 (no Docker needed: the repo is
|
||||
# local to the job, wherever the job runs).
|
||||
bin="$work/gitleaks"
|
||||
if [ ! -x "$bin" ]; then
|
||||
case "$(uname -m)" in
|
||||
x86_64) arch=x64; sum="$GITLEAKS_SHA256_X64" ;;
|
||||
aarch64|arm64) arch=arm64; sum="$GITLEAKS_SHA256_ARM64" ;;
|
||||
*) echo "::error::no pinned gitleaks binary for $(uname -m)"; exit 1 ;;
|
||||
esac
|
||||
curl -fsSL -o "$work/gl.tgz" \
|
||||
"https://github.com/gitleaks/gitleaks/releases/download/v${GITLEAKS_VERSION}/gitleaks_${GITLEAKS_VERSION}_linux_${arch}.tar.gz"
|
||||
echo "$sum $work/gl.tgz" | sha256sum -c --quiet
|
||||
tar -xzf "$work/gl.tgz" -C "$work" gitleaks
|
||||
fi
|
||||
|
||||
opts="$LOG_OPTS"
|
||||
if [ -z "$opts" ]; then
|
||||
zero=0000000000000000000000000000000000000000
|
||||
if [ -n "$BEFORE" ] && [ "$BEFORE" != "$zero" ]; then
|
||||
# Checkouts are often shallow: deepen until the old head is there.
|
||||
for _ in 1 2 3 4 5 6; do
|
||||
git cat-file -e "$BEFORE^{commit}" 2>/dev/null && break
|
||||
git fetch -q --deepen=100 origin 2>/dev/null || break
|
||||
done
|
||||
if git cat-file -e "$BEFORE^{commit}" 2>/dev/null; then
|
||||
opts="--first-parent --diff-merges=off $BEFORE..$SHA"
|
||||
fi
|
||||
fi
|
||||
if [ -z "$opts" ]; then
|
||||
# One commit (dispatch/cron). In a depth-1 checkout it has no
|
||||
# parent and would be diffed as a root commit, i.e. the whole
|
||||
# tree (upstream files of a fork included): fetch its parent.
|
||||
head="${SHA:-HEAD}"
|
||||
git rev-parse -q --verify "$head^" >/dev/null 2>&1 || git fetch -q --deepen=1 origin 2>/dev/null || true
|
||||
opts="--diff-merges=off -1 $head"
|
||||
fi
|
||||
fi
|
||||
if [ -n "$CONFIG" ] && [ -f "$CONFIG" ]; then
|
||||
cfg=(--config "$CONFIG")
|
||||
else
|
||||
cat >"$work/default.toml" <<'TOML'
|
||||
[extend]
|
||||
useDefault = true
|
||||
|
||||
[[allowlists]]
|
||||
description = "test files and fixtures"
|
||||
paths = [
|
||||
'(^|/)(tests?|__tests__|testdata|fixtures?|e2e)/',
|
||||
'_test\.(go|dart|py)$',
|
||||
'(^|/)test_[^/]*\.py$',
|
||||
'\.(test|spec)\.(ts|js|mjs|tsx)$',
|
||||
'(^|/)test-[^/]*\.js$',
|
||||
]
|
||||
TOML
|
||||
cfg=(--config "$work/default.toml")
|
||||
fi
|
||||
echo "gitleaks over: git log $opts"
|
||||
|
||||
rc=0
|
||||
"$bin" git --no-banner --redact --log-level warn "${cfg[@]}" --log-opts "$opts" \
|
||||
--report-format json --report-path "$work/report.json" . || rc=$?
|
||||
[ "$rc" -le 1 ] || { echo "::error::gitleaks failed (exit $rc)"; exit 1; }
|
||||
n=$(jq length "$work/report.json" 2>/dev/null || echo 0)
|
||||
echo "findings=$n" >>"$GITHUB_OUTPUT"
|
||||
if [ "$n" -gt 0 ]; then
|
||||
jq -r '.[] | [.RuleID, .File, (.StartLine|tostring), .Commit[0:10]] | @tsv' "$work/report.json" \
|
||||
| { printf 'RULE\tFILE\tLINE\tCOMMIT\n'; cat; } \
|
||||
| { if command -v column >/dev/null; then column -t -s $'\t'; else cat; fi; }
|
||||
if [ "$MODE" = block ]; then
|
||||
echo "::error::gitleaks: $n secrets in the pushed commits - rotate them, then allowlist or rewrite"
|
||||
exit 1
|
||||
fi
|
||||
echo "::warning::gitleaks (warn mode): $n secrets in the pushed commits would block"
|
||||
else
|
||||
echo "gitleaks: no secrets in the pushed commits"
|
||||
fi
|
||||
@@ -0,0 +1,193 @@
|
||||
name: portainer-deploy
|
||||
description: >
|
||||
Update a Portainer Swarm stack from a compose file in the repository. The
|
||||
compose file is the single source of truth: Portainer's stored compose is
|
||||
replaced on every deploy, the stack's env vars (where the secrets live) are
|
||||
kept and only the given variables are overwritten. Images are re-pulled.
|
||||
Config files from the repo can be shipped as content-addressed Swarm
|
||||
configs. Optionally waits until a URL answers with the expected status.
|
||||
|
||||
inputs:
|
||||
url:
|
||||
description: Portainer base URL.
|
||||
required: true
|
||||
token:
|
||||
description: Portainer API key (X-API-Key).
|
||||
required: true
|
||||
stack-id:
|
||||
description: >
|
||||
Portainer stack id. Empty = skip the deploy with a notice (a repo that
|
||||
has no stack yet).
|
||||
default: ""
|
||||
compose-file:
|
||||
description: Compose file in the checkout to deploy.
|
||||
required: true
|
||||
endpoint-id:
|
||||
description: Portainer environment (endpoint) id.
|
||||
default: "1"
|
||||
vars:
|
||||
description: >
|
||||
Stack variables to set, one NAME=value per line (e.g. IMAGE_TAG=sha-1234abcd).
|
||||
Every other stack variable is kept as it is.
|
||||
default: ""
|
||||
configs:
|
||||
description: >
|
||||
Files shipped as Swarm configs, one VAR=path per line. Each file becomes
|
||||
a config named <config-prefix><var>-<sha256[:12] of the content>
|
||||
(created when missing) and the stack variable VAR is set to that name,
|
||||
so the compose file references it as
|
||||
`{external: true, name: "${VAR}"}`. A changed file = a new config =
|
||||
the service is updated; older versions of the same VAR are removed once
|
||||
no service uses them.
|
||||
default: ""
|
||||
config-prefix:
|
||||
description: Prefix of the config names (e.g. the stack name and an underscore).
|
||||
default: ""
|
||||
prune:
|
||||
description: Remove services that are no longer in the compose file.
|
||||
default: "false"
|
||||
smoke-url:
|
||||
description: URL polled after the deploy until it answers smoke-status. Empty = no check.
|
||||
default: ""
|
||||
smoke-status:
|
||||
description: Expected HTTP status of smoke-url.
|
||||
default: "200"
|
||||
smoke-timeout:
|
||||
description: Seconds to wait for smoke-url.
|
||||
default: "180"
|
||||
|
||||
runs:
|
||||
using: composite
|
||||
steps:
|
||||
- shell: bash
|
||||
env:
|
||||
PORTAINER_URL: ${{ inputs.url }}
|
||||
PORTAINER_TOKEN: ${{ inputs.token }}
|
||||
STACK_ID: ${{ inputs.stack-id }}
|
||||
COMPOSE_FILE: ${{ inputs.compose-file }}
|
||||
ENDPOINT_ID: ${{ inputs.endpoint-id }}
|
||||
SET_VARS: ${{ inputs.vars }}
|
||||
CONFIGS: ${{ inputs.configs }}
|
||||
CONFIG_PREFIX: ${{ inputs.config-prefix }}
|
||||
PRUNE: ${{ inputs.prune }}
|
||||
SMOKE_URL: ${{ inputs.smoke-url }}
|
||||
SMOKE_STATUS: ${{ inputs.smoke-status }}
|
||||
SMOKE_TIMEOUT: ${{ inputs.smoke-timeout }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [ -z "$STACK_ID" ]; then
|
||||
echo "::notice::portainer-deploy: no stack id, deploy skipped"
|
||||
exit 0
|
||||
fi
|
||||
# The stack env carries the secrets: it only ever lives in this
|
||||
# process's memory, between the GET and the PUT, never in the log.
|
||||
python3 - <<'PY'
|
||||
import base64, hashlib, json, os, ssl, sys, time, urllib.error, urllib.parse, urllib.request
|
||||
|
||||
E = os.environ
|
||||
base = E["PORTAINER_URL"].rstrip("/")
|
||||
token = E["PORTAINER_TOKEN"]
|
||||
stack_id, endpoint = E["STACK_ID"], E.get("ENDPOINT_ID") or "1"
|
||||
if not base or not token:
|
||||
sys.exit("::error::portainer-deploy: url and token are required")
|
||||
|
||||
def api(method, path, body=None, ok=(200,)):
|
||||
req = urllib.request.Request(base + path, method=method,
|
||||
headers={"X-API-Key": token, "Content-Type": "application/json"},
|
||||
data=None if body is None else json.dumps(body).encode())
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=120) as r:
|
||||
status, raw = r.status, r.read()
|
||||
except urllib.error.HTTPError as e:
|
||||
status, raw = e.code, e.read()
|
||||
if status not in ok:
|
||||
raise RuntimeError(f"{method} {path.split('?')[0]} -> HTTP {status}: {raw[:300].decode(errors='replace')}")
|
||||
return status, (json.loads(raw) if raw.strip() else None)
|
||||
|
||||
def lines(name):
|
||||
out = {}
|
||||
for line in E.get(name, "").splitlines():
|
||||
line = line.strip()
|
||||
if not line:
|
||||
continue
|
||||
key, sep, value = line.partition("=")
|
||||
if not sep or not key.strip():
|
||||
sys.exit(f"::error::portainer-deploy: bad {name.lower()} line (want NAME=value): {key!r}")
|
||||
out[key.strip()] = value.strip() if name == "CONFIGS" else value
|
||||
return out
|
||||
|
||||
try:
|
||||
sets = lines("SET_VARS")
|
||||
docker = f"/api/endpoints/{endpoint}/docker"
|
||||
|
||||
# Content-addressed configs: the name changes with the content, so
|
||||
# a changed file rolls the services that mount it.
|
||||
prefix = E.get("CONFIG_PREFIX", "")
|
||||
stale = []
|
||||
for var, path in lines("CONFIGS").items():
|
||||
with open(path, "rb") as f:
|
||||
data = f.read()
|
||||
stem = f"{prefix}{var.lower()}"
|
||||
name = f"{stem}-{hashlib.sha256(data).hexdigest()[:12]}"
|
||||
flt = urllib.parse.quote(json.dumps({"label": [f"portainer-deploy.config={stem}"]}))
|
||||
_, existing = api("GET", f"{docker}/configs?filters={flt}")
|
||||
names = {c["Spec"]["Name"]: c["ID"] for c in existing or []}
|
||||
if name in names:
|
||||
print(f"config {name} ({path}) unchanged")
|
||||
else:
|
||||
api("POST", f"{docker}/configs/create", {
|
||||
"Name": name,
|
||||
"Data": base64.b64encode(data).decode(),
|
||||
"Labels": {"portainer-deploy.config": stem},
|
||||
}, ok=(200, 201))
|
||||
print(f"config {name} created from {path}")
|
||||
stale += [(n, i) for n, i in names.items() if n != name]
|
||||
sets[var] = name
|
||||
|
||||
_, stack = api("GET", f"/api/stacks/{stack_id}")
|
||||
env = [e for e in (stack.get("Env") or []) if e.get("name") not in sets]
|
||||
kept = len(env)
|
||||
env += [{"name": k, "value": v} for k, v in sets.items()]
|
||||
with open(E["COMPOSE_FILE"]) as f:
|
||||
compose = f.read()
|
||||
api("PUT", f"/api/stacks/{stack_id}?endpointId={endpoint}", {
|
||||
"stackFileContent": compose,
|
||||
"env": env,
|
||||
"prune": E.get("PRUNE", "false").lower() == "true",
|
||||
"pullImage": True,
|
||||
})
|
||||
shown = ", ".join(f"{k}={v}" for k, v in sets.items()) or "nothing"
|
||||
print(f"stack {stack.get('Name', stack_id)} updated from {E['COMPOSE_FILE']}: {shown}; {kept} other variable(s) kept")
|
||||
|
||||
# Older versions go once nothing mounts them; Docker refuses to
|
||||
# delete a config in use (the previous task may still be draining),
|
||||
# the next deploy retries.
|
||||
for name, cid in stale:
|
||||
try:
|
||||
api("DELETE", f"{docker}/configs/{cid}", ok=(200, 204))
|
||||
print(f"config {name} removed (superseded)")
|
||||
except RuntimeError:
|
||||
print(f"config {name} still in use, kept for the next deploy")
|
||||
except (RuntimeError, OSError) as exc:
|
||||
sys.exit(f"::error::portainer-deploy: {exc}")
|
||||
|
||||
url = E.get("SMOKE_URL", "")
|
||||
if url:
|
||||
want, deadline = E.get("SMOKE_STATUS", "200"), time.time() + float(E.get("SMOKE_TIMEOUT") or 180)
|
||||
ctx = ssl.create_default_context()
|
||||
ctx.check_hostname, ctx.verify_mode = False, ssl.CERT_NONE
|
||||
while True:
|
||||
try:
|
||||
with urllib.request.urlopen(url, timeout=10, context=ctx) as r:
|
||||
got = str(r.status)
|
||||
except urllib.error.HTTPError as e:
|
||||
got = str(e.code)
|
||||
except (urllib.error.URLError, OSError):
|
||||
got = "000"
|
||||
if got == want:
|
||||
print(f"smoke: {url} answered {got}")
|
||||
break
|
||||
if time.time() >= deadline:
|
||||
sys.exit(f"::error::smoke: {url} answered {got}, expected {want}")
|
||||
time.sleep(10)
|
||||
PY
|
||||
+116
-25
@@ -1,13 +1,30 @@
|
||||
name: trivy-gate
|
||||
description: >
|
||||
Scan a pushed image with Trivy and fail when it has fixable vulnerabilities
|
||||
of the given severities or embedded secrets. Run it on the immutable tag,
|
||||
before the floating tag (latest / stable-*) moves and before any deploy.
|
||||
Scan a pushed image (or a source tree's lockfiles) with Trivy and fail when
|
||||
it has fixable vulnerabilities of the given severities or embedded secrets.
|
||||
Run it on the immutable tag, before the floating tag (latest / stable-*)
|
||||
moves and before any deploy or release.
|
||||
|
||||
inputs:
|
||||
image:
|
||||
description: Full image reference, ideally the immutable sha tag.
|
||||
required: true
|
||||
description: Full image reference, ideally the immutable sha tag (scan-type image).
|
||||
default: ""
|
||||
scan-type:
|
||||
description: "image = pushed container image, fs = files in the workspace (lockfiles)."
|
||||
default: image
|
||||
scan-ref:
|
||||
description: Directory for scan-type fs (git-tracked files plus untracked lockfiles).
|
||||
default: .
|
||||
scanners:
|
||||
description: >
|
||||
Trivy scanners. vuln and secret findings block (per mode); misconfig
|
||||
(Dockerfile, compose, k8s, ...) is only reported, never blocks.
|
||||
default: vuln,secret
|
||||
runtime:
|
||||
description: >
|
||||
auto = Trivy container when a Docker daemon is reachable, else the
|
||||
pinned Trivy binary (checksum-verified); docker / binary force one.
|
||||
default: auto
|
||||
username:
|
||||
description: Registry user (private images).
|
||||
default: ""
|
||||
@@ -33,7 +50,7 @@ inputs:
|
||||
default: "false"
|
||||
trivy-image:
|
||||
description: Trivy container image, pinned by digest.
|
||||
default: aquasec/trivy:0.75.0@sha256:af6acf9a6b85dfe389a1941505c0ce9efef52a4719635e1a962f022a3d855daa
|
||||
default: aquasec/trivy:0.76.1@sha256:790fd66d1697395d8693d1acaa1ea702406a20f109b6fc7bac8db623eca6c06c
|
||||
cache-volume:
|
||||
description: >
|
||||
Docker named volume for the vulnerability DB. A named volume, not a
|
||||
@@ -56,6 +73,13 @@ runs:
|
||||
shell: bash
|
||||
env:
|
||||
IMAGE: ${{ inputs.image }}
|
||||
SCAN_TYPE: ${{ inputs.scan-type }}
|
||||
SCAN_REF: ${{ inputs.scan-ref }}
|
||||
RUNTIME: ${{ inputs.runtime }}
|
||||
SCANNERS: ${{ inputs.scanners }}
|
||||
TRIVY_VERSION: "0.76.1"
|
||||
TRIVY_SHA256_AMD64: c7cbe3137fb8a48a17574bede3dd6beb16742d1e9772929940fc90082c39d9c0
|
||||
TRIVY_SHA256_ARM64: e174dff2a6dba5e3ae41f8d0537a6324405bd08132497340304c6b20e0f16a1f
|
||||
TRIVY_USERNAME: ${{ inputs.username }}
|
||||
TRIVY_PASSWORD: ${{ inputs.password }}
|
||||
PLATFORM: ${{ inputs.platform }}
|
||||
@@ -68,37 +92,94 @@ runs:
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [ "$SKIP" = "true" ]; then
|
||||
echo "::warning::TRIVY GATE SKIPPED for $IMAGE (manual bypass)"
|
||||
echo "::warning::TRIVY GATE SKIPPED for ${IMAGE:-$SCAN_REF} (manual bypass)"
|
||||
echo "report=" >>"$GITHUB_OUTPUT"; echo "blocking=0" >>"$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
case "$MODE" in block|warn) ;; *) echo "::error::mode must be block or warn"; exit 1 ;; esac
|
||||
|
||||
work="${RUNNER_TEMP:-/tmp}/trivy-gate"; mkdir -p "$work"
|
||||
report="$work/$(printf '%s' "$IMAGE" | tr -c 'A-Za-z0-9._-' '_').json"
|
||||
case "$SCAN_TYPE" in
|
||||
image) [ -n "$IMAGE" ] || { echo "::error::image is required"; exit 1; }; target="$IMAGE" ;;
|
||||
fs) target="fs:$(cd "$SCAN_REF" && pwd)" ;;
|
||||
*) echo "::error::scan-type must be image or fs"; exit 1 ;;
|
||||
esac
|
||||
report="$work/$(printf '%s' "$target" | tr -c 'A-Za-z0-9._-' '_').json"
|
||||
|
||||
# DB refresh under an exclusive lock (parallel matrix jobs share the
|
||||
# volume); Trivy only downloads when the DB is older than its
|
||||
# NextUpdate. Scans then read the volume read-only under a shared lock.
|
||||
docker run --rm -v "$VOLUME:/cache" --entrypoint sh "$TRIVY" -c \
|
||||
'flock /cache/.lock trivy image --download-db-only --cache-dir /cache --quiet'
|
||||
if [ "$RUNTIME" = auto ]; then
|
||||
if command -v docker >/dev/null && docker info >/dev/null 2>&1; then RUNTIME=docker; else RUNTIME=binary; fi
|
||||
fi
|
||||
if ! command -v jq >/dev/null; then
|
||||
echo "jq missing, installing"; (apt-get update -qq && apt-get install -y -qq jq) >/dev/null 2>&1 \
|
||||
|| { echo "::error::jq is required"; exit 1; }
|
||||
fi
|
||||
|
||||
common="--skip-java-db-update --scanners $SCANNERS --list-all-pkgs --format json --quiet"
|
||||
ignore_args=""
|
||||
if [ -n "$IGNOREFILE" ] && [ -f "$IGNOREFILE" ]; then
|
||||
ignore_args="--ignorefile /tmp/ignore.yaml"
|
||||
echo "ignore file: $IGNOREFILE ($(grep -c -- '- id:' "$IGNOREFILE" || true) entries)"
|
||||
fi
|
||||
platform_args=""
|
||||
[ -z "$PLATFORM" ] || platform_args="--platform $PLATFORM"
|
||||
|
||||
# Image is pulled by Trivy from the registry (no daemon socket). The
|
||||
# ignore file goes in on stdin, outputs come back on stdout.
|
||||
docker run -i --rm -e TRIVY_USERNAME -e TRIVY_PASSWORD -v "$VOLUME:/cache:ro" \
|
||||
--entrypoint sh "$TRIVY" -c "cat >/tmp/ignore.yaml; flock -s /cache/.lock \
|
||||
trivy image --cache-dir /cache --skip-db-update --skip-java-db-update \
|
||||
--cache-backend memory --image-src remote --scanners vuln,secret --list-all-pkgs \
|
||||
--format json --quiet $ignore_args $platform_args \"\$0\"" "$IMAGE" \
|
||||
< <( [ -n "$ignore_args" ] && cat "$IGNOREFILE" || true ) >"$report"
|
||||
# fs scans see the git-tracked files plus lockfiles generated in the
|
||||
# job even when .gitignore lists them (Flutter ignores pubspec.lock).
|
||||
fs_list() {
|
||||
(cd "$SCAN_REF" && { git ls-files 2>/dev/null || find . -type f -not -path './.git/*'; \
|
||||
git ls-files --others 2>/dev/null \
|
||||
| grep -E '(^|/)([^/]*\.lock|[^/]*lock\.json|[^/]*\.lockfile)$' \
|
||||
| grep -vE '(^|/)(node_modules|build|\.dart_tool|\.pub-cache|\.gradle)/' || true; } \
|
||||
| sort -u)
|
||||
}
|
||||
|
||||
if [ "$RUNTIME" = docker ]; then
|
||||
# DB refresh under an exclusive lock (parallel matrix jobs share the
|
||||
# volume); Trivy only downloads when the DB is older than its
|
||||
# NextUpdate. Scans then read the volume read-only under a shared lock.
|
||||
docker run --rm -v "$VOLUME:/cache" --entrypoint sh "$TRIVY" -c \
|
||||
'flock /cache/.lock trivy image --download-db-only --cache-dir /cache --quiet'
|
||||
if [ "$SCAN_TYPE" = image ]; then
|
||||
[ -z "$IGNOREFILE" ] || [ ! -f "$IGNOREFILE" ] || ignore_args="--ignorefile /tmp/ignore.yaml"
|
||||
# Image is pulled by Trivy from the registry (no daemon socket). The
|
||||
# ignore file goes in on stdin, outputs come back on stdout.
|
||||
docker run -i --rm -e TRIVY_USERNAME -e TRIVY_PASSWORD -v "$VOLUME:/cache:ro" \
|
||||
--entrypoint sh "$TRIVY" -c "cat >/tmp/ignore.yaml; flock -s /cache/.lock \
|
||||
trivy image --cache-dir /cache --skip-db-update --cache-backend memory \
|
||||
--image-src remote $common $ignore_args $platform_args \"\$0\"" "$IMAGE" \
|
||||
< <( [ -n "$ignore_args" ] && cat "$IGNOREFILE" || true ) >"$report"
|
||||
else
|
||||
# The job's paths do not exist for the host daemon: the tree goes
|
||||
# in as a tar stream on stdin.
|
||||
[ -z "$IGNOREFILE" ] || [ ! -f "$IGNOREFILE" ] || ignore_args="--ignorefile /src/$IGNOREFILE"
|
||||
fs_list | (cd "$SCAN_REF" && tar -c -T -) | docker run -i --rm -v "$VOLUME:/cache:ro" \
|
||||
--entrypoint sh "$TRIVY" -c "mkdir /src && tar -x -C /src && flock -s /cache/.lock \
|
||||
trivy fs --cache-dir /cache --skip-db-update --cache-backend memory \
|
||||
$common $ignore_args /src" >"$report"
|
||||
fi
|
||||
else
|
||||
bin="$work/bin/trivy"
|
||||
if [ ! -x "$bin" ]; then
|
||||
case "$(uname -m)" in
|
||||
x86_64) arch=64bit; sum="$TRIVY_SHA256_AMD64" ;;
|
||||
aarch64|arm64) arch=ARM64; sum="$TRIVY_SHA256_ARM64" ;;
|
||||
*) echo "::error::no pinned Trivy binary for $(uname -m)"; exit 1 ;;
|
||||
esac
|
||||
mkdir -p "$work/bin"
|
||||
curl -fsSL -o "$work/trivy.tgz" \
|
||||
"https://github.com/aquasecurity/trivy/releases/download/v${TRIVY_VERSION}/trivy_${TRIVY_VERSION}_Linux-${arch}.tar.gz"
|
||||
echo "$sum $work/trivy.tgz" | sha256sum -c --quiet
|
||||
tar -xzf "$work/trivy.tgz" -C "$work/bin" trivy
|
||||
fi
|
||||
[ -z "$IGNOREFILE" ] || [ ! -f "$IGNOREFILE" ] || ignore_args="--ignorefile $IGNOREFILE"
|
||||
if [ "$SCAN_TYPE" = image ]; then
|
||||
"$bin" image --cache-dir "$work/cache" --cache-backend memory --image-src remote \
|
||||
$common $ignore_args $platform_args "$IMAGE" >"$report"
|
||||
else
|
||||
mkdir -p "$work/src"; rm -rf "${work:?}/src/"*
|
||||
fs_list | (cd "$SCAN_REF" && tar -c -T -) | tar -x -C "$work/src"
|
||||
"$bin" fs --cache-dir "$work/cache" --cache-backend memory $common $ignore_args "$work/src" >"$report"
|
||||
fi
|
||||
fi
|
||||
|
||||
table() { if command -v column >/dev/null; then column -t -s $'\t'; else cat; fi; }
|
||||
sev_json=$(jq -cn --arg s "$SEVERITY" '$s | split(",") | map(ascii_upcase | gsub(" "; ""))')
|
||||
@@ -113,7 +194,7 @@ runs:
|
||||
unfixed=$(jq --argjson sev "$sev_json" '[.Results[]?.Vulnerabilities[]?
|
||||
| select((.Severity as $x | $sev | index($x)) and ((.FixedVersion // "") == ""))] | length' "$report")
|
||||
|
||||
echo "Trivy $IMAGE: $nv fixable $SEVERITY, $ns secrets ($unfixed $SEVERITY without a fix, not blocking)"
|
||||
echo "Trivy $target: $nv fixable $SEVERITY, $ns secrets ($unfixed $SEVERITY without a fix, not blocking)"
|
||||
if [ "$nv" -gt 0 ]; then
|
||||
{ printf 'SEVERITY\tID\tPACKAGE\tINSTALLED\tFIXED\tTARGET\n'; cat "$work/vulns.tsv"; } | table
|
||||
fi
|
||||
@@ -121,13 +202,23 @@ runs:
|
||||
{ printf 'SECRET\tRULE\tTITLE\tFILE\tLINE\n'; cat "$work/secrets.tsv"; } | table
|
||||
fi
|
||||
|
||||
# Misconfigurations: reported, never blocking.
|
||||
jq -r --argjson sev "$sev_json" '[.Results[]? | .Target as $t | .Misconfigurations[]?
|
||||
| select(.Status == "FAIL" and (.Severity as $x | $sev | index($x)))
|
||||
| [.Severity, .ID, .Title, $t]] | unique | .[] | @tsv' "$report" >"$work/misconf.tsv"
|
||||
nm=$(wc -l <"$work/misconf.tsv")
|
||||
if [ "$nm" -gt 0 ]; then
|
||||
echo "::warning::Trivy config: $nm $SEVERITY misconfigurations in $target (not blocking)"
|
||||
{ printf 'SEVERITY\tID\tTITLE\tFILE\n'; cat "$work/misconf.tsv"; } | table
|
||||
fi
|
||||
|
||||
blocking=$((nv + ns))
|
||||
echo "report=$report" >>"$GITHUB_OUTPUT"
|
||||
echo "blocking=$blocking" >>"$GITHUB_OUTPUT"
|
||||
if [ "$blocking" -gt 0 ]; then
|
||||
if [ "$MODE" = block ]; then
|
||||
echo "::error::Trivy gate: $blocking blocking findings in $IMAGE"
|
||||
echo "::error::Trivy gate: $blocking blocking findings in $target"
|
||||
exit 1
|
||||
fi
|
||||
echo "::warning::Trivy gate (warn mode): $blocking findings in $IMAGE would block"
|
||||
echo "::warning::Trivy gate (warn mode): $blocking findings in $target would block"
|
||||
fi
|
||||
Reference in new issue
Block a user