docker/actions-toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

buildx(build): preserve original paths for file secrets

Browse Source 
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax
2026-03-20 10:47:59 +01:00
parent 9505deb078
commit 8b5d8e53b6
2 changed files with 56 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
__tests__/buildx/build.test.ts
View File

@@ -267,44 +267,63 @@ describe('resolveProvenanceAttrs', () => {
}); });
describe('resolveSecret', () => { describe('resolveSecret', () => {
// prettier-ignore
test.each([ test.each([
['A_SECRET=abcdef0123456789', false, 'A_SECRET', 'abcdef0123456789', null], ['A_SECRET=abcdef0123456789', 'A_SECRET', 'abcdef0123456789'],
['GIT_AUTH_TOKEN=abcdefghijklmno=0123456789', false, 'GIT_AUTH_TOKEN', 'abcdefghijklmno=0123456789', null], ['GIT_AUTH_TOKEN=abcdefghijklmno=0123456789', 'GIT_AUTH_TOKEN', 'abcdefghijklmno=0123456789'],
['MY_KEY=c3RyaW5nLXdpdGgtZXF1YWxzCg==', false, 'MY_KEY', 'c3RyaW5nLXdpdGgtZXF1YWxzCg==', null], ['MY_KEY=c3RyaW5nLXdpdGgtZXF1YWxzCg==', 'MY_KEY', 'c3RyaW5nLXdpdGgtZXF1YWxzCg==']
['aaaaaaaa', false, '', '', new Error('aaaaaaaa is not a valid secret')], ])('given %o key and string secret', (kvp: string, exKey: string, exValue: string) => {
['aaaaaaaa=', false, '', '', new Error('aaaaaaaa= is not a valid secret')], const secret = Build.resolveSecretString(kvp);
['=bbbbbbb', false, '', '', new Error('=bbbbbbb is not a valid secret')], expect(secret).toEqual(`id=${exKey},src=${tmpName}`);
[`foo=${path.join(fixturesDir, 'secret.txt')}`, true, 'foo', 'bar', null], expect(fs.readFileSync(tmpName, 'utf-8')).toEqual(exValue);
[`notfound=secret`, true, '', '', new Error('secret file secret not found')]
])('given %o key and %o secret', async (kvp: string, file: boolean, exKey: string, exValue: string, error: Error | null) => {
try {
let secret: string;
if (file) {
secret = Build.resolveSecretFile(kvp);
} else {
secret = Build.resolveSecretString(kvp);
}
expect(secret).toEqual(`id=${exKey},src=${tmpName}`);
expect(fs.readFileSync(tmpName, 'utf-8')).toEqual(exValue);
} catch (e) {
// eslint-disable-next-line vitest/no-conditional-expect
expect(e.message).toEqual(error?.message);
}
}); });
// prettier-ignore
test.each([ test.each([
['FOO=bar', 'FOO', 'bar', null], [`foo=${path.join(fixturesDir, 'secret.txt')}`, 'foo', path.join(fixturesDir, 'secret.txt')]
['FOO=', 'FOO', '', new Error('FOO= is not a valid secret')], ])('given %o key and file secret', (kvp: string, exKey: string, exSrc: string) => {
['=bar', '', '', new Error('=bar is not a valid secret')], const secret = Build.resolveSecretFile(kvp);
['FOO=bar=baz', 'FOO', 'bar=baz', null] expect(secret).toEqual(`id=${exKey},src=${exSrc}`);
])('given %o key and %o env', async (kvp: string, exKey: string, exValue: string, error: Error | null) => { });
try {
const secret = Build.resolveSecretEnv(kvp); // prettier-ignore
expect(secret).toEqual(`id=${exKey},env=${exValue}`); test.each([
} catch (e) { ['aaaaaaaa', false, 'aaaaaaaa is not a valid secret'],
// eslint-disable-next-line vitest/no-conditional-expect ['aaaaaaaa=', false, 'aaaaaaaa= is not a valid secret'],
expect(e.message).toEqual(error?.message); ['=bbbbbbb', false, '=bbbbbbb is not a valid secret'],
} ['notfound=secret', true, 'secret file secret not found']
])('given %o key and %o secret throws', (kvp: string, file: boolean, errorMessage: string) => {
const resolve = (): string => (file ? Build.resolveSecretFile(kvp) : Build.resolveSecretString(kvp));
expect(resolve).toThrow(errorMessage);
});
// prettier-ignore
test('preserves file-backed secret path and bytes', async () => {
fs.mkdirSync(tmpDir, {recursive: true});
const sourceFile = path.join(tmpDir, 'secret.bin');
const sourceBytes = Buffer.from([0x50, 0x4b, 0x03, 0x04, 0x00, 0xff, 0x41, 0x42, 0x43, 0x0a, 0x80]);
fs.writeFileSync(sourceFile, sourceBytes);
const secret = Build.resolveSecretFile(`foo=${sourceFile}`);
expect(secret).toEqual(`id=foo,src=${sourceFile}`);
expect(fs.readFileSync(sourceFile)).toEqual(sourceBytes);
expect(fs.existsSync(tmpName)).toBeFalsy();
});
// prettier-ignore
test.each([
['FOO=bar', 'FOO', 'bar'],
['FOO=bar=baz', 'FOO', 'bar=baz']
])('given %o key and %o env', (kvp: string, exKey: string, exValue: string) => {
const secret = Build.resolveSecretEnv(kvp);
expect(secret).toEqual(`id=${exKey},env=${exValue}`);
});
// prettier-ignore
test.each([
['FOO=', 'FOO= is not a valid secret'],
['=bar', '=bar is not a valid secret']
])('given %o key and %o env throws', (kvp: string, errorMessage: string) => {
expect(() => Build.resolveSecretEnv(kvp)).toThrow(errorMessage);
}); });
}); });

7
src/buildx/build.ts
View File

@@ -206,15 +206,14 @@ export class Build {
public static resolveSecret(kvp: string, opts?: ResolveSecretsOpts): [string, string] { public static resolveSecret(kvp: string, opts?: ResolveSecretsOpts): [string, string] {
const [key, value] = Build.parseSecretKvp(kvp, opts?.redact); const [key, value] = Build.parseSecretKvp(kvp, opts?.redact);
const secretFile = Context.tmpName({tmpdir: Context.tmpDir()});
if (opts?.asFile) { if (opts?.asFile) {
if (!fs.existsSync(value)) { if (!fs.existsSync(value)) {
throw new Error(`secret file ${value} not found`); throw new Error(`secret file ${value} not found`);
} }
fs.copyFileSync(value, secretFile); return [key, value];
} else {
fs.writeFileSync(secretFile, value);
} }
const secretFile = Context.tmpName({tmpdir: Context.tmpDir()});
fs.writeFileSync(secretFile, value);
return [key, secretFile]; return [key, secretFile];
} }