kata-containers/tests/govulncheck-runner.sh
Mitch Zhu 292c27130d ci: Add optional govulncheck security scanning to static checks
This adds govulncheck vulnerability scanning as a non-blocking check in
the static checks workflow. The check scans Go runtime binaries for known
vulnerabilities while filtering out verified false positives.

Signed-off-by: Mitch Zhu <mitchzhu@microsoft.com>
2025-06-17 20:43:00 -07:00

120 lines
4.3 KiB
Bash

#!/bin/bash
#
# Copyright (c) Microsoft Corporation.
#
# SPDX-License-Identifier: Apache-2.0
# Run govulncheck security scanning on given binary
set -euo pipefail
# Check arguments
if [[ $# -ne 1 ]]; then
echo "Usage: $0 <binary_path>"
echo "Example: $0 ./kata-runtime"
exit 1
fi
binary_path="$1"
binary_name=$(basename "${binary_path}")
declare -A false_positives
# Known false positives
# GO-2025-3595: golang.org/x/net/html - verified not compiled into binary
# GO-2025-3488: golang.org/x/oauth2/jws - verified not compiled into binary
# GO-2024-3169: github.com/containers/podman vulnerability not in annotations.go (only constants used)
# GO-2024-3042: github.com/containers/podman CVE-2024-3056 not in annotations.go (only constants used)
# GO-2023-1962: github.com/containers/podman CVE-2018-10856 not in annotations.go (only constants used)
# GO-2023-1942: github.com/containers/podman CVE-2019-18466 not in annotations.go (only constants used)
# GO-2022-1159: github.com/containers/podman CVE-2022-4123 not in annotations.go (only constants used)
false_positives["containerd-shim-kata-v2"]="GO-2025-3595 \
GO-2025-3488 \
GO-2024-3169 \
GO-2024-3042 \
GO-2023-1962 \
GO-2023-1942 \
GO-2022-1159"
# GO-2025-3595: golang.org/x/net/html - verified not compiled into binary
# GO-2025-3488: golang.org/x/oauth2/jws - verified not compiled into binary
# GO-2024-3169: github.com/containers/podman vulnerability not in annotations.go (only constants used)
# GO-2024-3042: github.com/containers/podman CVE-2024-3056 not in annotations.go (only constants used)
# GO-2023-1962: github.com/containers/podman CVE-2018-10856 not in annotations.go (only constants used)
# GO-2023-1942: github.com/containers/podman CVE-2019-18466 not in annotations.go (only constants used)
# GO-2022-1159: github.com/containers/podman CVE-2022-4123 not in annotations.go (only constants used)
false_positives["kata-runtime"]="GO-2025-3595 \
GO-2025-3488 \
GO-2024-3169 \
GO-2024-3042 \
GO-2023-1962 \
GO-2023-1942 \
GO-2022-1159"
# GO-2025-3595: golang.org/x/net/html - verified not compiled into binary
# GO-2025-3488: golang.org/x/oauth2/jws - verified not compiled into binary
# GO-2024-3169: github.com/containers/podman vulnerability not in annotations.go (only constants used)
# GO-2024-3042: github.com/containers/podman CVE-2024-3056 not in annotations.go (only constants used)
# GO-2023-1962: github.com/containers/podman CVE-2018-10856 not in annotations.go (only constants used)
# GO-2023-1942: github.com/containers/podman CVE-2019-18466 not in annotations.go (only constants used)
# GO-2022-1159: github.com/containers/podman CVE-2022-4123 not in annotations.go (only constants used)
false_positives["kata-monitor"]="GO-2025-3595 \
GO-2025-3488 \
GO-2024-3169 \
GO-2024-3042 \
GO-2023-1962 \
GO-2023-1942 \
GO-2022-1159"
# Function to filter false positives and return both result and filtered output
# This is required as at the moment there is no native support for silencing vulnerability findings.
# See https://go.dev/issue/61211 for updates.
filter_and_check() {
local binary_name="$1"
local output="$2"
local fp_list="${false_positives[${binary_name}]:-}"
if [[ -z "${fp_list}" ]]; then
if grep -q "GO-\|vulnerability" <<< "${output}"; then
echo "${output}"
false
else
true
fi
return
fi
# Filter out false positives and summary lines
local filtered_output="${output}"
for fp_id in ${fp_list}; do
filtered_output=$(echo "${filtered_output}" | sed "/^Vulnerability #[0-9]*: ${fp_id}/,/^$/d")
done
filtered_output=$(echo "${filtered_output}" | grep -v "Your code is affected by.*vulnerabilities" || true)
# Check if any real vulnerabilities remain
if grep -q "GO-" <<< "${filtered_output}"; then
echo "${filtered_output}"
false
else
true
fi
}
# Check if binary exists
if [[ ! -f "${binary_path}" ]]; then
echo "Error: Binary ${binary_path} not found"
exit 1
fi
echo "=== Running govulncheck on ${binary_name} ==="
govulncheck_output=$(govulncheck -mode=binary "${binary_path}" 2>&1 || true)
if filtered_output=$(filter_and_check "${binary_name}" "${govulncheck_output}"); then
echo " No vulnerabilities found in ${binary_name}"
exit 0
else
echo " Vulnerabilities found in ${binary_name}:"
echo "${filtered_output}"
exit 1
fi