mirror of https://github.com/actions/checkout
Compare commits
3 Commits
4cfef1b845
...
33605ef243
| Author | SHA1 | Date |
|---|---|---|
|
|
33605ef243 | |
|
|
12cd2235ef | |
|
|
2d76d21b2e |
|
|
@ -923,6 +923,25 @@ describe('git-auth-helper tests', () => {
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
const configureGlobalAuth_overridesGitConfigGlobal =
|
||||||
|
'configureGlobalAuth overrides GIT_CONFIG_GLOBAL'
|
||||||
|
it(configureGlobalAuth_overridesGitConfigGlobal, async () => {
|
||||||
|
// Arrange
|
||||||
|
await setup(configureGlobalAuth_overridesGitConfigGlobal)
|
||||||
|
const authHelper = gitAuthHelper.createAuthHelper(git, settings)
|
||||||
|
|
||||||
|
// Act
|
||||||
|
await authHelper.configureAuth()
|
||||||
|
await authHelper.configureGlobalAuth()
|
||||||
|
|
||||||
|
// Assert GIT_CONFIG_GLOBAL is pinned to the temporary global config, so an
|
||||||
|
// inherited GIT_CONFIG_GLOBAL cannot redirect --global writes
|
||||||
|
expect(git.env['HOME']).toBeTruthy()
|
||||||
|
expect(git.env['GIT_CONFIG_GLOBAL']).toBe(
|
||||||
|
path.join(git.env['HOME'], '.gitconfig')
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
const removeGlobalConfig_removesOverride =
|
const removeGlobalConfig_removesOverride =
|
||||||
'removeGlobalConfig removes override'
|
'removeGlobalConfig removes override'
|
||||||
it(removeGlobalConfig_removesOverride, async () => {
|
it(removeGlobalConfig_removesOverride, async () => {
|
||||||
|
|
@ -933,6 +952,7 @@ describe('git-auth-helper tests', () => {
|
||||||
await authHelper.configureGlobalAuth()
|
await authHelper.configureGlobalAuth()
|
||||||
const homeOverride = git.env['HOME'] // Sanity check
|
const homeOverride = git.env['HOME'] // Sanity check
|
||||||
expect(homeOverride).toBeTruthy()
|
expect(homeOverride).toBeTruthy()
|
||||||
|
expect(git.env['GIT_CONFIG_GLOBAL']).toBeTruthy()
|
||||||
await fs.promises.stat(path.join(git.env['HOME'], '.gitconfig'))
|
await fs.promises.stat(path.join(git.env['HOME'], '.gitconfig'))
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
|
|
@ -940,6 +960,7 @@ describe('git-auth-helper tests', () => {
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
expect(git.env['HOME']).toBeUndefined()
|
expect(git.env['HOME']).toBeUndefined()
|
||||||
|
expect(git.env['GIT_CONFIG_GLOBAL']).toBeUndefined()
|
||||||
try {
|
try {
|
||||||
await fs.promises.stat(homeOverride)
|
await fs.promises.stat(homeOverride)
|
||||||
throw new Error(`Should have been deleted '${homeOverride}'`)
|
throw new Error(`Should have been deleted '${homeOverride}'`)
|
||||||
|
|
|
||||||
|
|
@ -24,9 +24,20 @@ const mockGithubContext: any = {
|
||||||
payload: {}
|
payload: {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Replicate @actions/core getInput behavior: it trims whitespace by default
|
||||||
|
// (String.prototype.trim(), which strips characters such as a leading U+FEFF BOM)
|
||||||
|
// unless trimWhitespace is explicitly set to false.
|
||||||
|
const getInputImpl = (name: string, options?: {trimWhitespace?: boolean}) => {
|
||||||
|
const val = inputs[name] ?? ''
|
||||||
|
if (options && options.trimWhitespace === false) {
|
||||||
|
return val
|
||||||
|
}
|
||||||
|
return typeof val === 'string' ? val.trim() : val
|
||||||
|
}
|
||||||
|
|
||||||
// Mock @actions/core before loading input-helper
|
// Mock @actions/core before loading input-helper
|
||||||
jest.unstable_mockModule('@actions/core', () => ({
|
jest.unstable_mockModule('@actions/core', () => ({
|
||||||
getInput: jest.fn((name: string) => inputs[name]),
|
getInput: jest.fn(getInputImpl),
|
||||||
getBooleanInput: jest.fn((name: string) => inputs[name]),
|
getBooleanInput: jest.fn((name: string) => inputs[name]),
|
||||||
getMultilineInput: jest.fn((name: string) =>
|
getMultilineInput: jest.fn((name: string) =>
|
||||||
inputs[name] ? String(inputs[name]).split('\n').filter(Boolean) : []
|
inputs[name] ? String(inputs[name]).split('\n').filter(Boolean) : []
|
||||||
|
|
@ -76,9 +87,7 @@ describe('input-helper tests', () => {
|
||||||
inputs = {}
|
inputs = {}
|
||||||
jest.clearAllMocks()
|
jest.clearAllMocks()
|
||||||
// Re-apply default mocks
|
// Re-apply default mocks
|
||||||
;(core.getInput as jest.Mock<any>).mockImplementation(
|
;(core.getInput as jest.Mock<any>).mockImplementation(getInputImpl as any)
|
||||||
(name: string) => inputs[name]
|
|
||||||
)
|
|
||||||
mockDirectoryExistsSync.mockImplementation(
|
mockDirectoryExistsSync.mockImplementation(
|
||||||
(p: string) => p === gitHubWorkspace
|
(p: string) => p === gitHubWorkspace
|
||||||
)
|
)
|
||||||
|
|
@ -176,6 +185,36 @@ describe('input-helper tests', () => {
|
||||||
expect(settings.commit).toBeFalsy()
|
expect(settings.commit).toBeFalsy()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('does not reclassify a ref as sha when a BOM is prefixed', async () => {
|
||||||
|
// A fork branch named "<U+FEFF>" + 40 hex chars. core.getInput trims the
|
||||||
|
// BOM by default, which previously collapsed this into a bare SHA and
|
||||||
|
// bypassed the unsafe fork PR checkout guard.
|
||||||
|
inputs.ref = '\uFEFF522d932fae5296da51fdf431934425ecf891c6a2'
|
||||||
|
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
||||||
|
expect(settings.commit).toBeFalsy()
|
||||||
|
expect(settings.ref).toBe('522d932fae5296da51fdf431934425ecf891c6a2')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not reclassify a sha-256 ref as sha when a BOM is prefixed', async () => {
|
||||||
|
inputs.ref =
|
||||||
|
'\uFEFF1111111111222222222233333333334444444444555555555566666666667777'
|
||||||
|
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
||||||
|
expect(settings.commit).toBeFalsy()
|
||||||
|
expect(settings.ref).toBe(
|
||||||
|
'1111111111222222222233333333334444444444555555555566666666667777'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('treats a sha surrounded by ascii whitespace as a commit', async () => {
|
||||||
|
// ASCII whitespace can only come from the workflow author's YAML (git ref
|
||||||
|
// names cannot contain it), so trimming it and treating the value as a
|
||||||
|
// commit is safe.
|
||||||
|
inputs.ref = ' 1111111111222222222233333333334444444444 '
|
||||||
|
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
||||||
|
expect(settings.ref).toBeFalsy()
|
||||||
|
expect(settings.commit).toBe('1111111111222222222233333333334444444444')
|
||||||
|
})
|
||||||
|
|
||||||
it('sets workflow organization ID', async () => {
|
it('sets workflow organization ID', async () => {
|
||||||
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
const settings: IGitSourceSettings = await inputHelper.getInputs()
|
||||||
expect(settings.workflowOrganizationId).toBe(123456)
|
expect(settings.workflowOrganizationId).toBe(123456)
|
||||||
|
|
|
||||||
|
|
@ -35109,6 +35109,10 @@ class GitAuthHelper {
|
||||||
// Override HOME
|
// Override HOME
|
||||||
info(`Temporarily overriding HOME='${this.temporaryHomePath}' before making global git config changes`);
|
info(`Temporarily overriding HOME='${this.temporaryHomePath}' before making global git config changes`);
|
||||||
this.git.setEnvironmentVariable('HOME', this.temporaryHomePath);
|
this.git.setEnvironmentVariable('HOME', this.temporaryHomePath);
|
||||||
|
// GIT_CONFIG_GLOBAL takes precedence over HOME when locating the global
|
||||||
|
// config file. Pin it to the temporary config so an inherited
|
||||||
|
// GIT_CONFIG_GLOBAL cannot redirect our global git config writes elsewhere.
|
||||||
|
this.git.setEnvironmentVariable('GIT_CONFIG_GLOBAL', newGitConfigPath);
|
||||||
return newGitConfigPath;
|
return newGitConfigPath;
|
||||||
}
|
}
|
||||||
async configureGlobalAuth() {
|
async configureGlobalAuth() {
|
||||||
|
|
@ -35183,8 +35187,9 @@ class GitAuthHelper {
|
||||||
}
|
}
|
||||||
async removeGlobalConfig() {
|
async removeGlobalConfig() {
|
||||||
if (this.temporaryHomePath?.length > 0) {
|
if (this.temporaryHomePath?.length > 0) {
|
||||||
core_debug(`Unsetting HOME override`);
|
core_debug(`Unsetting HOME and GIT_CONFIG_GLOBAL overrides`);
|
||||||
this.git.removeEnvironmentVariable('HOME');
|
this.git.removeEnvironmentVariable('HOME');
|
||||||
|
this.git.removeEnvironmentVariable('GIT_CONFIG_GLOBAL');
|
||||||
await rmRF(this.temporaryHomePath);
|
await rmRF(this.temporaryHomePath);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -42100,6 +42105,22 @@ async function getInputs() {
|
||||||
`${github_context.repo.owner}/${github_context.repo.repo}`.toUpperCase();
|
`${github_context.repo.owner}/${github_context.repo.repo}`.toUpperCase();
|
||||||
// Source branch, source version
|
// Source branch, source version
|
||||||
result.ref = getInput('ref');
|
result.ref = getInput('ref');
|
||||||
|
// core.getInput()'s default trim strips a range of Unicode characters such as a
|
||||||
|
// leading BOM (U+FEFF) or NBSP (U+00A0). Those are valid in a git ref name, so
|
||||||
|
// a fork branch named "<BOM>" + 40 hex chars would trim down to a bare SHA and
|
||||||
|
// be silently reclassified as a commit, bypassing the unsafe fork PR checkout
|
||||||
|
// guard.
|
||||||
|
//
|
||||||
|
// The trim below strips only the ASCII whitespace characters which are all forbidden
|
||||||
|
// in a git branch name.
|
||||||
|
// \t U+0009 horizontal tab - ASCII control, forbidden in ref names
|
||||||
|
// \n U+000A line feed - ASCII control, forbidden in ref names
|
||||||
|
// \v U+000B vertical tab - ASCII control, forbidden in ref names
|
||||||
|
// \f U+000C form feed - ASCII control, forbidden in ref names
|
||||||
|
// \r U+000D carriage return - ASCII control, forbidden in ref names
|
||||||
|
// ' ' U+0020 space - forbidden in ref names
|
||||||
|
const asciiTrimmedRef = getInput('ref', { trimWhitespace: false })
|
||||||
|
.replace(/^[\t\n\v\f\r ]+|[\t\n\v\f\r ]+$/g, '');
|
||||||
if (!result.ref) {
|
if (!result.ref) {
|
||||||
if (isWorkflowRepository) {
|
if (isWorkflowRepository) {
|
||||||
result.ref = github_context.ref;
|
result.ref = github_context.ref;
|
||||||
|
|
@ -42112,8 +42133,8 @@ async function getInputs() {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// SHA?
|
// SHA?
|
||||||
else if (result.ref.match(/^(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$/)) {
|
else if (asciiTrimmedRef.match(/^(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$/)) {
|
||||||
result.commit = result.ref;
|
result.commit = asciiTrimmedRef;
|
||||||
result.ref = '';
|
result.ref = '';
|
||||||
}
|
}
|
||||||
core_debug(`ref = '${result.ref}'`);
|
core_debug(`ref = '${result.ref}'`);
|
||||||
|
|
|
||||||
|
|
@ -122,6 +122,11 @@ class GitAuthHelper {
|
||||||
)
|
)
|
||||||
this.git.setEnvironmentVariable('HOME', this.temporaryHomePath)
|
this.git.setEnvironmentVariable('HOME', this.temporaryHomePath)
|
||||||
|
|
||||||
|
// GIT_CONFIG_GLOBAL takes precedence over HOME when locating the global
|
||||||
|
// config file. Pin it to the temporary config so an inherited
|
||||||
|
// GIT_CONFIG_GLOBAL cannot redirect our global git config writes elsewhere.
|
||||||
|
this.git.setEnvironmentVariable('GIT_CONFIG_GLOBAL', newGitConfigPath)
|
||||||
|
|
||||||
return newGitConfigPath
|
return newGitConfigPath
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -237,8 +242,9 @@ class GitAuthHelper {
|
||||||
|
|
||||||
async removeGlobalConfig(): Promise<void> {
|
async removeGlobalConfig(): Promise<void> {
|
||||||
if (this.temporaryHomePath?.length > 0) {
|
if (this.temporaryHomePath?.length > 0) {
|
||||||
core.debug(`Unsetting HOME override`)
|
core.debug(`Unsetting HOME and GIT_CONFIG_GLOBAL overrides`)
|
||||||
this.git.removeEnvironmentVariable('HOME')
|
this.git.removeEnvironmentVariable('HOME')
|
||||||
|
this.git.removeEnvironmentVariable('GIT_CONFIG_GLOBAL')
|
||||||
await io.rmRF(this.temporaryHomePath)
|
await io.rmRF(this.temporaryHomePath)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -59,6 +59,23 @@ export async function getInputs(): Promise<IGitSourceSettings> {
|
||||||
|
|
||||||
// Source branch, source version
|
// Source branch, source version
|
||||||
result.ref = core.getInput('ref')
|
result.ref = core.getInput('ref')
|
||||||
|
// core.getInput()'s default trim strips a range of Unicode characters such as a
|
||||||
|
// leading BOM (U+FEFF) or NBSP (U+00A0). Those are valid in a git ref name, so
|
||||||
|
// a fork branch named "<BOM>" + 40 hex chars would trim down to a bare SHA and
|
||||||
|
// be silently reclassified as a commit, bypassing the unsafe fork PR checkout
|
||||||
|
// guard.
|
||||||
|
//
|
||||||
|
// The trim below strips only the ASCII whitespace characters which are all forbidden
|
||||||
|
// in a git branch name.
|
||||||
|
// \t U+0009 horizontal tab - ASCII control, forbidden in ref names
|
||||||
|
// \n U+000A line feed - ASCII control, forbidden in ref names
|
||||||
|
// \v U+000B vertical tab - ASCII control, forbidden in ref names
|
||||||
|
// \f U+000C form feed - ASCII control, forbidden in ref names
|
||||||
|
// \r U+000D carriage return - ASCII control, forbidden in ref names
|
||||||
|
// ' ' U+0020 space - forbidden in ref names
|
||||||
|
const asciiTrimmedRef = core
|
||||||
|
.getInput('ref', {trimWhitespace: false})
|
||||||
|
.replace(/^[\t\n\v\f\r ]+|[\t\n\v\f\r ]+$/g, '')
|
||||||
if (!result.ref) {
|
if (!result.ref) {
|
||||||
if (isWorkflowRepository) {
|
if (isWorkflowRepository) {
|
||||||
result.ref = github.context.ref
|
result.ref = github.context.ref
|
||||||
|
|
@ -72,8 +89,8 @@ export async function getInputs(): Promise<IGitSourceSettings> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
// SHA?
|
// SHA?
|
||||||
else if (result.ref.match(/^(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$/)) {
|
else if (asciiTrimmedRef.match(/^(?:[0-9a-fA-F]{40}|[0-9a-fA-F]{64})$/)) {
|
||||||
result.commit = result.ref
|
result.commit = asciiTrimmedRef
|
||||||
result.ref = ''
|
result.ref = ''
|
||||||
}
|
}
|
||||||
core.debug(`ref = '${result.ref}'`)
|
core.debug(`ref = '${result.ref}'`)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue