mirror of
https://github.com/goreleaser/goreleaser-action
synced 2026-06-29 21:29:42 +00:00
4b462d3d1d
* feat: verify release checksum and cosign signature Download checksums.txt for the release and verify the SHA-256 of the downloaded archive against it. When cosign is available in PATH, also download checksums.txt.sigstore.json and verify the signature against the goreleaser/goreleaser-pro release workflow identity. Both steps degrade gracefully (with a warning) when the corresponding artifacts or tooling are missing. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test: use install() for checksum e2e tests Drop the http-client download helper from verifyChecksum integration tests; call goreleaser.install() instead so the test exercises the public API path and avoids duplicating download logic. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
201 lines
6.7 KiB
TypeScript
201 lines
6.7 KiB
TypeScript
import * as crypto from 'crypto';
|
|
import * as fs from 'fs';
|
|
import * as path from 'path';
|
|
import yaml from 'js-yaml';
|
|
import * as context from './context';
|
|
import * as github from './github';
|
|
import * as core from '@actions/core';
|
|
import * as exec from '@actions/exec';
|
|
import * as io from '@actions/io';
|
|
import * as tc from '@actions/tool-cache';
|
|
|
|
export async function install(distribution: string, version: string): Promise<string> {
|
|
const release: github.GitHubRelease = await github.getRelease(distribution, version);
|
|
const filename = getFilename(distribution);
|
|
const baseUrl = `https://github.com/goreleaser/${distribution}/releases/download/${release.tag_name}`;
|
|
const downloadUrl = `${baseUrl}/${filename}`;
|
|
|
|
core.info(`Downloading ${downloadUrl}`);
|
|
const downloadPath: string = await tc.downloadTool(downloadUrl);
|
|
core.debug(`Downloaded to ${downloadPath}`);
|
|
|
|
await verifyChecksum(distribution, release.tag_name, downloadPath, filename);
|
|
|
|
core.info('Extracting GoReleaser');
|
|
let extPath: string;
|
|
if (context.osPlat == 'win32') {
|
|
if (!downloadPath.endsWith('.zip')) {
|
|
const newPath = downloadPath + '.zip';
|
|
fs.renameSync(downloadPath, newPath);
|
|
extPath = await tc.extractZip(newPath);
|
|
} else {
|
|
extPath = await tc.extractZip(downloadPath);
|
|
}
|
|
} else {
|
|
extPath = await tc.extractTar(downloadPath);
|
|
}
|
|
core.debug(`Extracted to ${extPath}`);
|
|
|
|
const cachePath: string = await tc.cacheDir(extPath, 'goreleaser-action', release.tag_name.replace(/^v/, ''));
|
|
core.debug(`Cached to ${cachePath}`);
|
|
|
|
const exePath: string = path.join(cachePath, context.osPlat == 'win32' ? 'goreleaser.exe' : 'goreleaser');
|
|
core.debug(`Exe path is ${exePath}`);
|
|
|
|
return exePath;
|
|
}
|
|
|
|
export async function verifyChecksum(
|
|
distribution: string,
|
|
tag: string,
|
|
archivePath: string,
|
|
filename: string
|
|
): Promise<void> {
|
|
const baseUrl = `https://github.com/goreleaser/${distribution}/releases/download/${tag}`;
|
|
let checksumsPath: string;
|
|
try {
|
|
core.info(`Downloading ${baseUrl}/checksums.txt`);
|
|
checksumsPath = await tc.downloadTool(`${baseUrl}/checksums.txt`);
|
|
} catch (e) {
|
|
core.warning(`Skipping checksum verification: unable to download checksums.txt: ${e.message}`);
|
|
return;
|
|
}
|
|
|
|
const sha256 = crypto.createHash('sha256').update(fs.readFileSync(archivePath)).digest('hex');
|
|
const expected = findChecksum(fs.readFileSync(checksumsPath, 'utf8'), filename);
|
|
if (!expected) {
|
|
throw new Error(`Could not find ${filename} in checksums.txt`);
|
|
}
|
|
if (expected.toLowerCase() !== sha256.toLowerCase()) {
|
|
throw new Error(`Checksum mismatch for ${filename}: expected ${expected}, got ${sha256}`);
|
|
}
|
|
core.info(`Checksum verified for ${filename}`);
|
|
|
|
await verifyCosignSignature(distribution, tag, baseUrl, checksumsPath);
|
|
}
|
|
|
|
export const findChecksum = (checksumsContent: string, filename: string): string | undefined => {
|
|
const match = checksumsContent
|
|
.split('\n')
|
|
.map(line => line.trim().split(/\s+/))
|
|
.find(parts => parts.length >= 2 && parts[1].replace(/^[*]/, '') === filename);
|
|
return match ? match[0] : undefined;
|
|
};
|
|
|
|
async function verifyCosignSignature(
|
|
distribution: string,
|
|
tag: string,
|
|
baseUrl: string,
|
|
checksumsPath: string
|
|
): Promise<void> {
|
|
const cosign = await io.which('cosign', false);
|
|
if (!cosign) {
|
|
core.info('cosign not found in PATH, skipping signature verification');
|
|
return;
|
|
}
|
|
|
|
let bundlePath: string;
|
|
try {
|
|
core.info(`Downloading ${baseUrl}/checksums.txt.sigstore.json`);
|
|
bundlePath = await tc.downloadTool(`${baseUrl}/checksums.txt.sigstore.json`);
|
|
} catch (e) {
|
|
core.warning(`Skipping cosign signature verification: unable to download sigstore bundle: ${e.message}`);
|
|
return;
|
|
}
|
|
|
|
const certificateIdentity = getCertificateIdentity(distribution, tag);
|
|
core.info(`Verifying checksums.txt signature with cosign (identity: ${certificateIdentity})`);
|
|
await exec.exec(cosign, [
|
|
'verify-blob',
|
|
'--certificate-identity',
|
|
certificateIdentity,
|
|
'--certificate-oidc-issuer',
|
|
'https://token.actions.githubusercontent.com',
|
|
'--bundle',
|
|
bundlePath,
|
|
checksumsPath
|
|
]);
|
|
core.info('cosign signature verified');
|
|
}
|
|
|
|
export const getCertificateIdentity = (distribution: string, tag: string): string => {
|
|
const pro = isPro(distribution);
|
|
if (tag === 'nightly') {
|
|
const workflow = pro ? 'nightly-pro.yml' : 'nightly-oss.yml';
|
|
const repo = pro ? 'goreleaser-pro-internal' : 'goreleaser';
|
|
return `https://github.com/goreleaser/${repo}/.github/workflows/${workflow}@refs/heads/main`;
|
|
}
|
|
if (pro) {
|
|
return `https://github.com/goreleaser/goreleaser-pro-internal/.github/workflows/release-pro.yml@refs/tags/${tag}`;
|
|
}
|
|
return `https://github.com/goreleaser/goreleaser/.github/workflows/release.yml@refs/tags/${tag}`;
|
|
};
|
|
|
|
export const distribSuffix = (distribution: string): string => {
|
|
return isPro(distribution) ? '-pro' : '';
|
|
};
|
|
|
|
export const isPro = (distribution: string): boolean => {
|
|
return distribution === 'goreleaser-pro';
|
|
};
|
|
|
|
const getFilename = (distribution: string): string => {
|
|
let arch: string;
|
|
switch (context.osArch) {
|
|
case 'x64': {
|
|
arch = 'x86_64';
|
|
break;
|
|
}
|
|
case 'x32': {
|
|
arch = 'i386';
|
|
break;
|
|
}
|
|
case 'arm': {
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
const arm_version = (process.config.variables as any).arm_version;
|
|
arch = arm_version ? 'armv' + arm_version : 'arm';
|
|
break;
|
|
}
|
|
default: {
|
|
arch = context.osArch;
|
|
break;
|
|
}
|
|
}
|
|
if (context.osPlat == 'darwin') {
|
|
arch = 'all';
|
|
}
|
|
const platform: string = context.osPlat == 'win32' ? 'Windows' : context.osPlat == 'darwin' ? 'Darwin' : 'Linux';
|
|
const ext: string = context.osPlat == 'win32' ? 'zip' : 'tar.gz';
|
|
const suffix: string = distribSuffix(distribution);
|
|
return `goreleaser${suffix}_${platform}_${arch}.${ext}`;
|
|
};
|
|
|
|
export async function getDistPath(yamlfile: string): Promise<string> {
|
|
const cfg = yaml.load(fs.readFileSync(yamlfile, 'utf8'));
|
|
return cfg.dist || 'dist';
|
|
}
|
|
|
|
export async function getArtifacts(distpath: string): Promise<string | undefined> {
|
|
const artifactsFile = path.join(distpath, 'artifacts.json');
|
|
if (!fs.existsSync(artifactsFile)) {
|
|
return undefined;
|
|
}
|
|
const content = fs.readFileSync(artifactsFile, {encoding: 'utf-8'}).trim();
|
|
if (content === 'null') {
|
|
return undefined;
|
|
}
|
|
return content;
|
|
}
|
|
|
|
export async function getMetadata(distpath: string): Promise<string | undefined> {
|
|
const metadataFile = path.join(distpath, 'metadata.json');
|
|
if (!fs.existsSync(metadataFile)) {
|
|
return undefined;
|
|
}
|
|
const content = fs.readFileSync(metadataFile, {encoding: 'utf-8'}).trim();
|
|
if (content === 'null') {
|
|
return undefined;
|
|
}
|
|
return content;
|
|
}
|