Compare commits

..

7 Commits

Author SHA1 Message Date
Aiqiao Yan 921dc8dd24 edit url one more time 2026-06-15 21:41:19 +00:00
Aiqiao Yan baaeba4a5e update description and url again 2026-06-15 21:07:44 +00:00
Aiqiao Yan cb140b4908 update readme 2026-06-15 20:16:22 +00:00
Aiqiao Yan 678aa28ba1 update urls 2026-06-15 20:07:36 +00:00
Aiqiao Yan c2edb9a740 build 2026-06-15 17:26:12 +00:00
Aiqiao Yan c12eb249cb run prettier formatting 2026-06-15 16:18:29 +00:00
Aiqiao Yan 12a489776f address copilot and reviewer feedback 2026-06-15 16:12:03 +00:00
5 changed files with 59 additions and 24 deletions
+5 -2
View File
@@ -162,8 +162,11 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
github-server-url: '' github-server-url: ''
# Required to check out fork pull request code from a workflow triggered by # Required to check out fork pull request code from a workflow triggered by
# `pull_request_target` or `workflow_run`. See [Pwn Requests](todo:need-link) for # `pull_request_target` or `workflow_run`. These workflows run with the base
# the risks. Set to `true` only after reviewing the risks. # repository's GITHUB_TOKEN, secrets, default-branch cache scope, and runner
# access; fetching and executing a fork's code in that trusted context commonly
# leads to "pwn request" vulnerabilities. Set to `true` only after reviewing the
# risks at https://gh.io/securely-using-pull_request_target.
# Default: false # Default: false
allow-unsafe-pr-checkout: '' allow-unsafe-pr-checkout: ''
``` ```
+19 -6
View File
@@ -13,6 +13,7 @@ const PR_MERGE_SHA = '2222222222222222222222222222222222222222'
const SAFE_BASE_SHA = '3333333333333333333333333333333333333333' const SAFE_BASE_SHA = '3333333333333333333333333333333333333333'
const WORKFLOW_RUN_HEAD_COMMIT_SHA = '4444444444444444444444444444444444444444' const WORKFLOW_RUN_HEAD_COMMIT_SHA = '4444444444444444444444444444444444444444'
const BASE_QUALIFIED_REPO = 'some-owner/some-repo' const BASE_QUALIFIED_REPO = 'some-owner/some-repo'
const FORK_QUALIFIED_REPO = 'another-repo/fork'
function setContext(eventName: string, payload: object): void { function setContext(eventName: string, payload: object): void {
;(github.context as {eventName: string}).eventName = eventName ;(github.context as {eventName: string}).eventName = eventName
@@ -25,7 +26,7 @@ function forkPullRequestTargetPayload(): object {
pull_request: { pull_request: {
head: { head: {
sha: PR_HEAD_SHA, sha: PR_HEAD_SHA,
repo: {id: FORK_REPO_ID} repo: {id: FORK_REPO_ID, full_name: FORK_QUALIFIED_REPO}
}, },
merge_commit_sha: PR_MERGE_SHA merge_commit_sha: PR_MERGE_SHA
} }
@@ -38,7 +39,7 @@ function sameRepoPullRequestTargetPayload(): object {
pull_request: { pull_request: {
head: { head: {
sha: PR_HEAD_SHA, sha: PR_HEAD_SHA,
repo: {id: BASE_REPO_ID} repo: {id: BASE_REPO_ID, full_name: BASE_QUALIFIED_REPO}
}, },
merge_commit_sha: PR_MERGE_SHA merge_commit_sha: PR_MERGE_SHA
} }
@@ -51,7 +52,7 @@ function forkWorkflowRunPayload(): object {
workflow_run: { workflow_run: {
event: 'pull_request', event: 'pull_request',
head_commit: {id: WORKFLOW_RUN_HEAD_COMMIT_SHA}, head_commit: {id: WORKFLOW_RUN_HEAD_COMMIT_SHA},
head_repository: {id: FORK_REPO_ID} head_repository: {id: FORK_REPO_ID, full_name: FORK_QUALIFIED_REPO}
} }
} }
} }
@@ -164,7 +165,7 @@ describe('unsafe-pr-checkout-helper', () => {
setContext('pull_request_target', forkPullRequestTargetPayload()) setContext('pull_request_target', forkPullRequestTargetPayload())
expect(() => expect(() =>
assertSafePrCheckout({ assertSafePrCheckout({
qualifiedRepository: 'attacker/fork', qualifiedRepository: FORK_QUALIFIED_REPO,
ref: 'refs/heads/main', ref: 'refs/heads/main',
commit: '', commit: '',
allowUnsafePrCheckout: false allowUnsafePrCheckout: false
@@ -172,13 +173,25 @@ describe('unsafe-pr-checkout-helper', () => {
).toThrow() ).toThrow()
}) })
it('allows pull_request_target checkout of an unrelated third-party repo', () => {
setContext('pull_request_target', forkPullRequestTargetPayload())
expect(() =>
assertSafePrCheckout({
qualifiedRepository: 'some-other/unrelated',
ref: 'refs/heads/main',
commit: '',
allowUnsafePrCheckout: false
})
).not.toThrow()
})
it('refuses pull_request_target ignoring repository case differences', () => { it('refuses pull_request_target ignoring repository case differences', () => {
setContext('pull_request_target', forkPullRequestTargetPayload()) setContext('pull_request_target', forkPullRequestTargetPayload())
expect(() => expect(() =>
assertSafePrCheckout({ assertSafePrCheckout({
qualifiedRepository: 'SOME-OWNER/SOME-REPO', qualifiedRepository: FORK_QUALIFIED_REPO.toUpperCase(),
ref: '', ref: '',
commit: PR_HEAD_SHA, commit: '',
allowUnsafePrCheckout: false allowUnsafePrCheckout: false
}) })
).toThrow() ).toThrow()
+5 -2
View File
@@ -101,8 +101,11 @@ inputs:
allow-unsafe-pr-checkout: allow-unsafe-pr-checkout:
description: > description: >
Required to check out fork pull request code from a workflow triggered by Required to check out fork pull request code from a workflow triggered by
`pull_request_target` or `workflow_run`. See [Pwn Requests](todo:need-link) `pull_request_target` or `workflow_run`. These workflows run with the
for the risks. Set to `true` only after reviewing the risks. base repository's GITHUB_TOKEN, secrets, default-branch cache scope, and
runner access; fetching and executing a fork's code in that trusted
context commonly leads to "pwn request" vulnerabilities. Set to `true`
only after reviewing the risks at https://gh.io/securely-using-pull_request_target.
default: false default: false
outputs: outputs:
ref: ref:
+14 -6
View File
@@ -2793,9 +2793,11 @@ function assertSafePrCheckout(input) {
return; return;
} }
let prHeadRepoId; let prHeadRepoId;
let prHeadRepoFullName;
const prShas = []; const prShas = [];
if (eventName === 'pull_request_target') { if (eventName === 'pull_request_target') {
prHeadRepoId = (0, ref_helper_1.fromPayload)('pull_request.head.repo.id'); prHeadRepoId = (0, ref_helper_1.fromPayload)('pull_request.head.repo.id');
prHeadRepoFullName = (0, ref_helper_1.fromPayload)('pull_request.head.repo.full_name');
pushIfSha(prShas, (0, ref_helper_1.fromPayload)('pull_request.head.sha')); pushIfSha(prShas, (0, ref_helper_1.fromPayload)('pull_request.head.sha'));
pushIfSha(prShas, (0, ref_helper_1.fromPayload)('pull_request.merge_commit_sha')); pushIfSha(prShas, (0, ref_helper_1.fromPayload)('pull_request.merge_commit_sha'));
} }
@@ -2805,7 +2807,13 @@ function assertSafePrCheckout(input) {
return; return;
} }
prHeadRepoId = (0, ref_helper_1.fromPayload)('workflow_run.head_repository.id'); prHeadRepoId = (0, ref_helper_1.fromPayload)('workflow_run.head_repository.id');
prHeadRepoFullName = (0, ref_helper_1.fromPayload)('workflow_run.head_repository.full_name');
pushIfSha(prShas, (0, ref_helper_1.fromPayload)('workflow_run.head_commit.id')); pushIfSha(prShas, (0, ref_helper_1.fromPayload)('workflow_run.head_commit.id'));
// For `pull_request_target`-triggered workflow_run, `head_sha` is the base
// default branch SHA (not the PR head)
if (wrEvent !== 'pull_request_target') {
pushIfSha(prShas, (0, ref_helper_1.fromPayload)('workflow_run.head_sha'));
}
} }
// (A) Fork PR? // (A) Fork PR?
if (typeof prHeadRepoId !== 'number' || prHeadRepoId === baseRepoId) { if (typeof prHeadRepoId !== 'number' || prHeadRepoId === baseRepoId) {
@@ -2813,20 +2821,20 @@ function assertSafePrCheckout(input) {
} }
// (B) We cannot check for all fork PR refs so check to see // (B) We cannot check for all fork PR refs so check to see
// if the resolved input points to the fork PR sha we have in the payload // if the resolved input points to the fork PR sha we have in the payload
const baseQualifiedRepository = `${github.context.repo.owner}/${github.context.repo.repo}`; const repositoryMatchesPrHead = typeof prHeadRepoFullName === 'string' &&
const repositoryDiffersFromBase = input.qualifiedRepository.toLowerCase() !== input.qualifiedRepository.toLowerCase() === prHeadRepoFullName.toLowerCase();
baseQualifiedRepository.toLowerCase();
const refMatchesPullPattern = PR_REF_PATTERN.test(input.ref); const refMatchesPullPattern = PR_REF_PATTERN.test(input.ref);
const commitMatchesPrHeadSha = !!input.commit && prShas.includes(input.commit.toLowerCase()); const commitMatchesPrHeadSha = !!input.commit && prShas.includes(input.commit.toLowerCase());
if (!repositoryDiffersFromBase && if (!repositoryMatchesPrHead &&
!refMatchesPullPattern && !refMatchesPullPattern &&
!commitMatchesPrHeadSha) { !commitMatchesPrHeadSha) {
return; return;
} }
throw new Error(`Refusing to check out fork pull request code from a '${eventName}' workflow. ` + throw new Error(`Refusing to check out fork pull request code from a '${eventName}' workflow. ` +
`This workflow runs with the base repository's GITHUB_TOKEN, secrets, default-branch ` + `This workflow runs with the base repository's GITHUB_TOKEN, secrets, default-branch ` +
`cache scope, and runner access. Fetching fork's code in that trusted context is a ` + `cache scope, and runner access. Fetching and executing a fork's code in that trusted ` +
`"pwn request" supply-chain attack pattern. To opt in after reviewing the risk, set ` + `context commonly leads to "pwn request" vulnerabilities. To opt in after reviewing ` +
`the risks at https://gh.io/securely-using-pull_request_target, set ` +
`'allow-unsafe-pr-checkout: true' on the actions/checkout step.`); `'allow-unsafe-pr-checkout: true' on the actions/checkout step.`);
} }
function pushIfSha(target, value) { function pushIfSha(target, value) {
+16 -8
View File
@@ -6,7 +6,7 @@ const PR_REF_PATTERN = /^refs\/pull\/[0-9]+\/(?:head|merge)$/
export interface IUnsafePrCheckoutInput { export interface IUnsafePrCheckoutInput {
qualifiedRepository: string qualifiedRepository: string
ref: string ref: string
commit: string commit: string | undefined
allowUnsafePrCheckout: boolean allowUnsafePrCheckout: boolean
} }
@@ -26,10 +26,12 @@ export function assertSafePrCheckout(input: IUnsafePrCheckoutInput): void {
} }
let prHeadRepoId: unknown let prHeadRepoId: unknown
let prHeadRepoFullName: unknown
const prShas: string[] = [] const prShas: string[] = []
if (eventName === 'pull_request_target') { if (eventName === 'pull_request_target') {
prHeadRepoId = fromPayload('pull_request.head.repo.id') prHeadRepoId = fromPayload('pull_request.head.repo.id')
prHeadRepoFullName = fromPayload('pull_request.head.repo.full_name')
pushIfSha(prShas, fromPayload('pull_request.head.sha')) pushIfSha(prShas, fromPayload('pull_request.head.sha'))
pushIfSha(prShas, fromPayload('pull_request.merge_commit_sha')) pushIfSha(prShas, fromPayload('pull_request.merge_commit_sha'))
} else { } else {
@@ -38,7 +40,13 @@ export function assertSafePrCheckout(input: IUnsafePrCheckoutInput): void {
return return
} }
prHeadRepoId = fromPayload('workflow_run.head_repository.id') prHeadRepoId = fromPayload('workflow_run.head_repository.id')
prHeadRepoFullName = fromPayload('workflow_run.head_repository.full_name')
pushIfSha(prShas, fromPayload('workflow_run.head_commit.id')) pushIfSha(prShas, fromPayload('workflow_run.head_commit.id'))
// For `pull_request_target`-triggered workflow_run, `head_sha` is the base
// default branch SHA (not the PR head)
if (wrEvent !== 'pull_request_target') {
pushIfSha(prShas, fromPayload('workflow_run.head_sha'))
}
} }
// (A) Fork PR? // (A) Fork PR?
@@ -48,16 +56,15 @@ export function assertSafePrCheckout(input: IUnsafePrCheckoutInput): void {
// (B) We cannot check for all fork PR refs so check to see // (B) We cannot check for all fork PR refs so check to see
// if the resolved input points to the fork PR sha we have in the payload // if the resolved input points to the fork PR sha we have in the payload
const baseQualifiedRepository = `${github.context.repo.owner}/${github.context.repo.repo}` const repositoryMatchesPrHead =
const repositoryDiffersFromBase = typeof prHeadRepoFullName === 'string' &&
input.qualifiedRepository.toLowerCase() !== input.qualifiedRepository.toLowerCase() === prHeadRepoFullName.toLowerCase()
baseQualifiedRepository.toLowerCase()
const refMatchesPullPattern = PR_REF_PATTERN.test(input.ref) const refMatchesPullPattern = PR_REF_PATTERN.test(input.ref)
const commitMatchesPrHeadSha = const commitMatchesPrHeadSha =
!!input.commit && prShas.includes(input.commit.toLowerCase()) !!input.commit && prShas.includes(input.commit.toLowerCase())
if ( if (
!repositoryDiffersFromBase && !repositoryMatchesPrHead &&
!refMatchesPullPattern && !refMatchesPullPattern &&
!commitMatchesPrHeadSha !commitMatchesPrHeadSha
) { ) {
@@ -67,8 +74,9 @@ export function assertSafePrCheckout(input: IUnsafePrCheckoutInput): void {
throw new Error( throw new Error(
`Refusing to check out fork pull request code from a '${eventName}' workflow. ` + `Refusing to check out fork pull request code from a '${eventName}' workflow. ` +
`This workflow runs with the base repository's GITHUB_TOKEN, secrets, default-branch ` + `This workflow runs with the base repository's GITHUB_TOKEN, secrets, default-branch ` +
`cache scope, and runner access. Fetching fork's code in that trusted context is a ` + `cache scope, and runner access. Fetching and executing a fork's code in that trusted ` +
`"pwn request" supply-chain attack pattern. To opt in after reviewing the risk, set ` + `context commonly leads to "pwn request" vulnerabilities. To opt in after reviewing ` +
`the risks at https://gh.io/securely-using-pull_request_target, set ` +
`'allow-unsafe-pr-checkout: true' on the actions/checkout step.` `'allow-unsafe-pr-checkout: true' on the actions/checkout step.`
) )
} }