Merge pull request #11400 from miz060/mitchzhu/add-govulncheck

ci: Add optional govulncheck security scanning to static checks
This commit is contained in:
Steve Horsman
2025-06-18 10:34:56 +01:00
committed by GitHub
3 changed files with 174 additions and 0 deletions

50
.github/workflows/govulncheck.yaml vendored Normal file
View File

@@ -0,0 +1,50 @@
on:
workflow_call:
name: Govulncheck
permissions:
contents: read
jobs:
govulncheck:
runs-on: ubuntu-22.04
strategy:
matrix:
include:
- binary: "kata-runtime"
make_target: "runtime"
- binary: "containerd-shim-kata-v2"
make_target: "containerd-shim-v2"
- binary: "kata-monitor"
make_target: "monitor"
fail-fast: false
steps:
- name: Checkout the code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
persist-credentials: false
- name: Install golang
run: |
./tests/install_go.sh -f -p
echo "/usr/local/go/bin" >> "${GITHUB_PATH}"
- name: Install govulncheck
run: |
go install golang.org/x/vuln/cmd/govulncheck@latest
echo "${HOME}/go/bin" >> "${GITHUB_PATH}"
- name: Build runtime binaries
run: |
cd src/runtime
make ${{ matrix.make_target }}
env:
SKIP_GO_VERSION_CHECK: "1"
- name: Run govulncheck on ${{ matrix.binary }}
run: |
cd src/runtime
bash ../../tests/govulncheck-runner.sh "./${{ matrix.binary }}"

View File

@@ -137,3 +137,8 @@ jobs:
run: |
export PATH="${PATH}:${GOPATH}/bin"
cd "${GOPATH}/src/github.com/${{ github.repository }}" && ${{ matrix.cmd }}
govulncheck:
needs: skipper
if: ${{ needs.skipper.outputs.skip_static != 'yes' }}
uses: ./.github/workflows/govulncheck.yaml

119
tests/govulncheck-runner.sh Normal file
View File

@@ -0,0 +1,119 @@
#!/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