|
| 1 | +// Check PR author permissions for pull_request_target events. |
| 2 | +// Used by the e2e workflow to gate CI runs on external PRs. |
| 3 | +// |
| 4 | +// Permission check order: |
| 5 | +// 1. Trusted bots (dependabot, renovate) |
| 6 | +// 2. Org/team membership |
| 7 | +// 3. Repository collaborator (write/admin) |
| 8 | +// 4. ok-to-test label (maintainer approval for external contributors) |
| 9 | +// |
| 10 | +// Security: on non-labeled events the ok-to-test label is removed |
| 11 | +// to force re-approval after code changes. |
| 12 | +module.exports = async ({ github, context, core }) => { |
| 13 | + if (!context || !context.payload || !context.payload.pull_request) { |
| 14 | + core.setFailed( |
| 15 | + "Invalid GitHub context: missing required pull_request information", |
| 16 | + ); |
| 17 | + return; |
| 18 | + } |
| 19 | + |
| 20 | + const actor = context.payload.pull_request.user.login; |
| 21 | + const repoOwner = context.repo.owner; |
| 22 | + const repoName = context.repo.repo; |
| 23 | + const targetOrg = context.repo.owner; |
| 24 | + |
| 25 | + core.info(`🔍 Starting permission check for user: @${actor}`); |
| 26 | + core.info(`📋 Repository: ${repoOwner}/${repoName}`); |
| 27 | + core.info(`🏢 Target organization: ${targetOrg}`); |
| 28 | + |
| 29 | + // Security: On non-labeled events (opened, reopened, synchronize), |
| 30 | + // remove the ok-to-test label if present. This prevents an external |
| 31 | + // contributor from pushing malicious code after a maintainer approved via label. |
| 32 | + if (context.payload.action !== "labeled") { |
| 33 | + const currentLabels = context.payload.pull_request.labels.map( |
| 34 | + (l) => l.name, |
| 35 | + ); |
| 36 | + if (currentLabels.includes("ok-to-test")) { |
| 37 | + core.info( |
| 38 | + `🔒 Removing ok-to-test label due to '${context.payload.action}' event — re-approval required.`, |
| 39 | + ); |
| 40 | + try { |
| 41 | + await github.rest.issues.removeLabel({ |
| 42 | + owner: repoOwner, |
| 43 | + repo: repoName, |
| 44 | + issue_number: context.payload.pull_request.number, |
| 45 | + name: "ok-to-test", |
| 46 | + }); |
| 47 | + core.info(` Label removed successfully.`); |
| 48 | + } catch (err) { |
| 49 | + core.warning(` Failed to remove ok-to-test label: ${err.message}`); |
| 50 | + } |
| 51 | + } |
| 52 | + } |
| 53 | + |
| 54 | + // Condition 1: Check if the user is a trusted bot. |
| 55 | + const trustedBots = ["dependabot[bot]", "renovate[bot]"]; |
| 56 | + core.info(`🤖 Checking if @${actor} is a trusted bot...`); |
| 57 | + core.info(` Trusted bots list: ${trustedBots.join(", ")}`); |
| 58 | + |
| 59 | + if (trustedBots.includes(actor)) { |
| 60 | + core.info( |
| 61 | + `✅ Condition met: User @${actor} is a trusted bot. Proceeding.`, |
| 62 | + ); |
| 63 | + return; |
| 64 | + } |
| 65 | + core.info(` ❌ User @${actor} is not a trusted bot.`); |
| 66 | + |
| 67 | + // Condition 2: Check for public membership in the target organization. |
| 68 | + core.info(`\n👥 Condition 2: Checking organization and team membership...`); |
| 69 | + core.info( |
| 70 | + `User @${actor} is not a trusted bot. Checking for membership in '${targetOrg}'...`, |
| 71 | + ); |
| 72 | + try { |
| 73 | + // Optional: check membership in one or more org teams (set TARGET_TEAM_SLUGS as comma-separated slugs in workflow env) |
| 74 | + const teamSlugsEnv = process.env.TARGET_TEAM_SLUGS || ""; |
| 75 | + const teamSlugs = teamSlugsEnv |
| 76 | + .split(",") |
| 77 | + .map((s) => s.trim()) |
| 78 | + .filter(Boolean); |
| 79 | + |
| 80 | + core.info(`🔧 TARGET_TEAM_SLUGS environment variable: "${teamSlugsEnv}"`); |
| 81 | + core.info(`📝 Parsed team slugs: [${teamSlugs.join(", ")}]`); |
| 82 | + |
| 83 | + if (teamSlugs.length > 0) { |
| 84 | + core.info( |
| 85 | + `🔍 Checking team membership for ${teamSlugs.length} team(s)...`, |
| 86 | + ); |
| 87 | + for (const team_slug of teamSlugs) { |
| 88 | + core.info(` Checking team: ${team_slug}...`); |
| 89 | + try { |
| 90 | + const membership = |
| 91 | + await github.rest.teams.getMembershipForUserInOrg({ |
| 92 | + org: targetOrg, |
| 93 | + team_slug, |
| 94 | + username: actor, |
| 95 | + }); |
| 96 | + core.info( |
| 97 | + ` API response for team '${team_slug}': ${JSON.stringify(membership.data)}`, |
| 98 | + ); |
| 99 | + if ( |
| 100 | + membership && |
| 101 | + membership.data && |
| 102 | + membership.data.state === "active" |
| 103 | + ) { |
| 104 | + core.info( |
| 105 | + `✅ Condition met: User @${actor} is a member of team '${team_slug}' in '${targetOrg}'. Proceeding.`, |
| 106 | + ); |
| 107 | + return; |
| 108 | + } else { |
| 109 | + core.info( |
| 110 | + ` ⚠️ Team membership found but state is not 'active': ${membership.data.state}`, |
| 111 | + ); |
| 112 | + } |
| 113 | + } catch (err) { |
| 114 | + core.info( |
| 115 | + ` ❌ User @${actor} is not a member of team '${team_slug}' (or team not found). Error: ${err.message}`, |
| 116 | + ); |
| 117 | + } |
| 118 | + } |
| 119 | + core.info( |
| 120 | + `ⓘ User @${actor} is not a member of any configured teams in '${targetOrg}'. Falling back to org membership checks.`, |
| 121 | + ); |
| 122 | + } else { |
| 123 | + core.info( |
| 124 | + `ℹ️ No teams configured in TARGET_TEAM_SLUGS. Skipping team membership checks.`, |
| 125 | + ); |
| 126 | + } |
| 127 | + core.info( |
| 128 | + `🏢 Checking organization membership for @${actor} in '${targetOrg}'...`, |
| 129 | + ); |
| 130 | + try { |
| 131 | + core.info(` Attempting checkMembershipForUser API call...`); |
| 132 | + await github.rest.orgs.checkMembershipForUser({ |
| 133 | + org: targetOrg, |
| 134 | + username: actor, |
| 135 | + }); |
| 136 | + core.info( |
| 137 | + `✅ Condition met: User @${actor} is a member of '${targetOrg}'. Proceeding.`, |
| 138 | + ); |
| 139 | + return; |
| 140 | + } catch (err) { |
| 141 | + core.info(` ❌ Private membership check failed: ${err.message}`); |
| 142 | + core.info(` Attempting checkPublicMembershipForUser API call...`); |
| 143 | + try { |
| 144 | + await github.rest.orgs.checkPublicMembershipForUser({ |
| 145 | + org: targetOrg, |
| 146 | + username: actor, |
| 147 | + }); |
| 148 | + core.info( |
| 149 | + `✅ Condition met: User @${actor} is a public member of '${targetOrg}'. Proceeding.`, |
| 150 | + ); |
| 151 | + return; |
| 152 | + } catch (publicErr) { |
| 153 | + core.info( |
| 154 | + ` ❌ Public membership check failed: ${publicErr.message}`, |
| 155 | + ); |
| 156 | + throw publicErr; |
| 157 | + } |
| 158 | + } |
| 159 | + } catch (error) { |
| 160 | + core.info( |
| 161 | + `ⓘ User @${actor} is not a public member of '${targetOrg}'. Checking repository permissions as a fallback.`, |
| 162 | + ); |
| 163 | + } |
| 164 | + |
| 165 | + // Condition 3: Check for write/admin permission on the repository. |
| 166 | + core.info( |
| 167 | + `\n🔐 Condition 3: Checking repository collaborator permissions...`, |
| 168 | + ); |
| 169 | + try { |
| 170 | + core.info(` Attempting getCollaboratorPermissionLevel API call...`); |
| 171 | + const response = await github.rest.repos.getCollaboratorPermissionLevel({ |
| 172 | + owner: repoOwner, |
| 173 | + repo: repoName, |
| 174 | + username: actor, |
| 175 | + }); |
| 176 | + |
| 177 | + const permission = response.data.permission; |
| 178 | + core.info( |
| 179 | + ` User @${actor} has '${permission}' permission on ${repoOwner}/${repoName}`, |
| 180 | + ); |
| 181 | + |
| 182 | + if (permission === "admin" || permission === "write") { |
| 183 | + core.info( |
| 184 | + `✅ Condition met: User @${actor} has '${permission}' repository permission. Proceeding.`, |
| 185 | + ); |
| 186 | + return; |
| 187 | + } else { |
| 188 | + core.info( |
| 189 | + ` ❌ Permission '${permission}' is insufficient (requires 'write' or 'admin')`, |
| 190 | + ); |
| 191 | + } |
| 192 | + } catch (error) { |
| 193 | + core.info(` ❌ Collaborator permission check failed: ${error.message}`); |
| 194 | + } |
| 195 | + |
| 196 | + // Condition 4: Check for ok-to-test label (for external contributors approved by maintainers). |
| 197 | + // Only users with repo write access can add labels, so this is inherently gated. |
| 198 | + core.info(`\n🏷️ Condition 4: Checking for ok-to-test label...`); |
| 199 | + if ( |
| 200 | + context.payload.action === "labeled" && |
| 201 | + context.payload.label && |
| 202 | + context.payload.label.name === "ok-to-test" |
| 203 | + ) { |
| 204 | + core.info( |
| 205 | + `✅ Condition met: ok-to-test label applied by @${context.actor}. Proceeding with tests.`, |
| 206 | + ); |
| 207 | + return; |
| 208 | + } |
| 209 | + |
| 210 | + core.info(` ❌ No ok-to-test label event detected.`); |
| 211 | + core.setFailed( |
| 212 | + `❌ Permission check failed. User @${actor} did not meet any required conditions (trusted bot, org/team member, repo write access, or ok-to-test label).`, |
| 213 | + ); |
| 214 | +}; |
0 commit comments