feat: verify Helm downloads and support fallback mirrors (#315)

* feat: verify Helm downloads and support fallback mirrors

* fix: strengthen Helm download fallback

* docs: align mirror example with Helm fallback

* fix: preserve custom mirror checksum compatibility

* fix: warn for missing checksums in auto mode
This commit is contained in:
David Gamero
2026-11-09 12:18:18 -08:00
committed by GitHub
parent 1548e57b4d
commit 4339b0e932
4 changed files with 421 additions and 19 deletions
+144 -10
View File
@@ -5,6 +5,7 @@ import * as os from 'os'
import * as path from 'path'
import * as util from 'util'
import * as fs from 'fs'
import {createHash} from 'crypto'
import * as toolCache from '@actions/tool-cache'
import * as core from '@actions/core'
@@ -12,6 +13,8 @@ import * as core from '@actions/core'
const helmToolName = 'helm'
export const stableHelmVersion = 'v4.3.1'
export type ChecksumPolicy = 'auto' | 'required' | 'if-available' | 'disabled'
export async function run() {
let version = core.getInput('version')
const versionFile = core.getInput('version-file')
@@ -32,6 +35,12 @@ export async function run() {
}
const downloadBaseURL = core.getInput('downloadBaseURL', {required: false})
const downloadBaseURLFallback = core.getInput('downloadBaseURLFallback', {
required: false
})
const checksumPolicy = getChecksumPolicy(
core.getInput('checksum-policy', {required: false})
)
if (version.toLocaleLowerCase() === 'latest') {
// Only an explicit 'false' turns the fallback off, matching the
@@ -40,7 +49,20 @@ export async function run() {
core.getInput('latest-fallback').toLowerCase() !== 'false'
version = await getLatestHelmVersion(fallbackToDefault)
} else if (isMajorMinorShaped(version)) {
version = await resolveLatestPatchVersion(downloadBaseURL, version)
try {
version = await resolveLatestPatchVersion(downloadBaseURL, version)
} catch (error) {
if (!downloadBaseURLFallback) {
throw error
}
core.warning(
`Unable to resolve the latest Helm patch from '${downloadBaseURL}': ${error instanceof Error ? error.message : String(error)}. Trying fallback '${downloadBaseURLFallback}'`
)
version = await resolveLatestPatchVersion(
downloadBaseURLFallback,
version
)
}
core.info(`Resolved latest patch Helm version to '${version}'`)
} else if (version[0] !== 'v') {
version = getValidVersion(version)
@@ -48,7 +70,12 @@ export async function run() {
}
core.startGroup(`Installing ${version}`)
const cachedPath = await downloadHelm(downloadBaseURL, version)
const cachedPath = await downloadHelm(
downloadBaseURL,
version,
downloadBaseURLFallback,
checksumPolicy
)
core.endGroup()
try {
@@ -68,6 +95,21 @@ export function getValidVersion(version: string): string {
return 'v' + version
}
export function getChecksumPolicy(value: string): ChecksumPolicy {
const policy = value.trim().toLowerCase() || 'auto'
if (
policy !== 'auto' &&
policy !== 'required' &&
policy !== 'if-available' &&
policy !== 'disabled'
) {
throw new Error(
`Invalid checksum-policy '${value}'. Expected auto, required, if-available, or disabled`
)
}
return policy
}
// Matches a complete semantic version (major.minor.patch with optional
// pre-release / build metadata). This is the official regex suggested at
// https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
@@ -336,9 +378,76 @@ export function getHelmDownloadURL(baseURL: string, version: string): string {
return url.toString()
}
export async function downloadAndVerifyHelm(
baseURL: string,
version: string,
policy: ChecksumPolicy = 'auto'
): Promise<string> {
const downloadURL = getHelmDownloadURL(baseURL, version)
const effectivePolicy = resolveChecksumPolicy(policy)
if (effectivePolicy === 'disabled') {
core.warning(
`Checksum verification is disabled for Helm downloads from '${baseURL}'`
)
return toolCache.downloadTool(downloadURL)
}
let checksum: string | undefined
try {
const checksumPath = await toolCache.downloadTool(`${downloadURL}.sha256`)
checksum = fs.readFileSync(checksumPath, 'utf8').trim()
} catch (error) {
if (
effectivePolicy === 'if-available' &&
isChecksumNotFoundError(error)
) {
core.warning(
`No SHA-256 checksum is available for ${downloadURL}; continuing without verification. Set checksum-policy to 'required' to fail instead.`
)
return toolCache.downloadTool(downloadURL)
}
throw error
}
if (!/^[a-fA-F0-9]{64}$/.test(checksum)) {
throw new Error(`Invalid SHA-256 checksum from ${downloadURL}.sha256`)
}
const archivePath = await toolCache.downloadTool(downloadURL)
const hash = createHash('sha256')
await new Promise<void>((resolve, reject) => {
const archive = fs.createReadStream(archivePath)
archive.on('data', (chunk) => hash.update(chunk))
archive.on('error', reject)
archive.on('end', resolve)
})
const actual = hash.digest('hex')
if (actual.toLowerCase() !== checksum.toLowerCase()) {
throw new Error(`SHA-256 checksum mismatch for ${downloadURL}`)
}
return archivePath
}
export function resolveChecksumPolicy(
policy: ChecksumPolicy
): Exclude<ChecksumPolicy, 'auto'> {
return policy === 'auto' ? 'if-available' : policy
}
function isChecksumNotFoundError(error: unknown): boolean {
return (
error instanceof toolCache.HTTPError &&
(error.httpStatusCode === 404 || error.httpStatusCode === 410)
)
}
export async function downloadHelm(
baseURL: string,
version: string
version: string,
fallbackBaseURL?: string,
checksumPolicy: ChecksumPolicy = 'auto'
): Promise<string> {
let cachedToolpath = toolCache.find(helmToolName, version)
if (cachedToolpath) {
@@ -347,15 +456,40 @@ export async function downloadHelm(
core.info(`Downloading '${version}' from '${baseURL}'`)
let helmDownloadPath
try {
helmDownloadPath = await toolCache.downloadTool(
getHelmDownloadURL(baseURL, version)
helmDownloadPath = await downloadAndVerifyHelm(
baseURL,
version,
checksumPolicy
)
} catch (exception) {
} catch (error) {
if (fallbackBaseURL) {
core.warning(
`Unable to download and verify Helm from '${baseURL}': ${error instanceof Error ? error.message : String(error)}. Trying fallback '${fallbackBaseURL}'`
)
try {
helmDownloadPath = await downloadAndVerifyHelm(
fallbackBaseURL,
version,
checksumPolicy
)
} catch (fallbackError) {
throw new Error(
`Failed to download and verify Helm from '${baseURL}' and fallback '${fallbackBaseURL}': ${fallbackError instanceof Error ? fallbackError.message : String(fallbackError)}`
)
}
} else {
throw new Error(
`Failed to download and verify Helm from location ${getHelmDownloadURL(
baseURL,
version
)}: ${error instanceof Error ? error.message : String(error)}`
)
}
}
if (!helmDownloadPath) {
throw new Error(
`Failed to download Helm from location ${getHelmDownloadURL(
baseURL,
version
)}`
`Failed to download and verify Helm version '${version}'`
)
}