-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathevaluator-core.ts
More file actions
524 lines (492 loc) · 37.8 KB
/
Copy pathevaluator-core.ts
File metadata and controls
524 lines (492 loc) · 37.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
import { determineFinalStatus } from "./contract/status-precedence.js";
import { decisionInputDigest, normalizedPolicyDigest, receiptDigest as calculateReceiptDigest } from "./evidence/digests.js";
import { evidenceReference, resolveCheckEvidence } from "./evidence/source-verifier.js";
import { EVALUATOR_VERSION } from "./version.js";
import type {
ContributionReceiptCore,
CheckEvidence,
EvaluationInput,
HumanGate,
NativeBranchProtection,
PatchgatePolicy,
Requirement,
RequirementResult,
ReviewSnapshot,
} from "./types.js";
const PATCHGATE_SOURCE = "patchgate.yml";
function isPatchgatePolicySource(source: { kind: string; identity: string }): boolean {
return source.kind === "patchgate" && (source.identity === "patchgate.yml" || source.identity === ".github/patchgate.yml");
}
function compareIds(left: { id: string }, right: { id: string }): number {
return left.id < right.id ? -1 : left.id > right.id ? 1 : 0;
}
function requirement(input: Omit<Requirement, "evidenceRefs"> & { evidenceRefs?: string[] }): Requirement {
return { ...input, evidenceRefs: input.evidenceRefs ?? [] };
}
function policyObservationComplete(input: EvaluationInput): boolean {
return input.observations.policySources.length > 0 && input.observations.policySources.every((meta) => meta.complete && meta.permissionState === "sufficient");
}
function groupAvailable(input: EvaluationInput, group: keyof EvaluationInput["observations"]): boolean {
if (group === "policySources") return policyObservationComplete(input);
const meta = input.observations[group];
return !Array.isArray(meta) && meta.complete && meta.permissionState === "sufficient";
}
function hasPatchgateSource(input: EvaluationInput): boolean {
if (!policyObservationComplete(input)) return false;
if (input.policy === null) return false;
const sources = input.policySources.filter((source) => isPatchgatePolicySource(source) && source.authority === "enforced");
if (sources.length !== 1) return false;
const source = sources[0]!;
return source.revision === input.revisions.baseSha && source.digest === input.policyDigest && source.contractDigest === normalizedPolicyDigest(input.policy);
}
function hasBasePolicySource(input: EvaluationInput, kind: "codeowners" | "ruleset" | "branch_protection"): boolean {
return input.policySources.some((source) => source.kind === kind && source.revision === input.revisions.baseSha && source.authority === "enforced");
}
function matchedPath(paths: string[], patterns: string[]): boolean {
return patterns.some((pattern) => {
const escaped = pattern.replace(/[.+^${}()|[\]\\?]/g, "\\$&").replace(/\*\*/g, "\u0000").replace(/\*/g, "[^/]*").replace(/\u0000/g, ".*");
const matcher = new RegExp(`^${escaped}$`);
return paths.some((path) => matcher.test(path));
});
}
function changedPolicyPaths(input: EvaluationInput, policy: PatchgatePolicy): string[] {
const identities = input.policySources.filter(isPatchgatePolicySource).map((source) => source.identity);
return [PATCHGATE_SOURCE, ...identities, ...(policy.policyChanges?.paths ?? [])];
}
function qualifiedApprovals(reviews: ReviewSnapshot[], targetSha: string, owners: string[]): ReviewSnapshot[] {
const activeByActor = new Map<number, ReviewSnapshot[]>();
for (const review of reviews.filter((candidate) => candidate.active)) {
const current = activeByActor.get(review.actorId) ?? [];
current.push(review);
activeByActor.set(review.actorId, current);
}
const eligible: ReviewSnapshot[] = [];
for (const actorReviews of activeByActor.values()) {
if (actorReviews.some((review) => review.state !== "APPROVED")) continue;
const review = actorReviews.find((candidate) =>
candidate.state === "APPROVED" &&
candidate.commitId === targetSha &&
candidate.qualified &&
candidate.qualification.complete &&
candidate.qualification.permissionState === "sufficient" &&
!candidate.isAuthor &&
!candidate.isBot &&
principalMatches(candidate, owners),
);
if (review !== undefined) eligible.push(review);
}
return eligible;
}
function hasUnknownQualification(reviews: ReviewSnapshot[], targetSha: string, owners: string[]): boolean {
return reviews.some((review) =>
review.active &&
review.state === "APPROVED" &&
review.commitId === targetSha &&
!review.isAuthor &&
!review.isBot &&
(owners.length === 0 || owners.includes(review.login) || owners.includes(`@${review.login}`) || review.teams.some((team) => owners.includes(team))) &&
(!review.qualification.complete || review.qualification.permissionState !== "sufficient" || !principalMatches(review, owners)),
);
}
function principalMatches(review: ReviewSnapshot, owners: string[]): boolean {
if (owners.length === 0) return true;
const bindings = review.qualification.principalBindings ?? [];
return owners.some((owner) => bindings.some((binding) => binding.configuredPrincipal === owner && binding.membershipState === "active" && (binding.kind === "user" ? owner === review.login || owner === `@${review.login}` : review.teams.includes(owner) && review.teamIds.includes(binding.immutableId))));
}
function observationRequirement(id: string, group: string, remediation: string): Requirement {
return requirement({ id, ruleClass: "policy_integrity", authority: "derived", source: `observation:${group}`, result: "unknown", severity: "evidence", observed: { observation: group }, remediation });
}
function policyRequirements(input: EvaluationInput): Requirement[] {
const policySource = input.policySources.find((source) => isPatchgatePolicySource(source));
const policyEvidenceRefs = policySource === undefined ? [] : [`policy-source:${policySource.identity}`];
if (!policyObservationComplete(input) || input.policy === null || !hasPatchgateSource(input)) {
return [requirement({
id: "policy.base_revision",
ruleClass: "policy_integrity",
authority: "patchgate",
source: PATCHGATE_SOURCE,
result: "unknown",
severity: "block",
remediation: "Load patchgate.yml from the trusted PR base SHA and bind both its raw and normalized contract digests before evaluating the PR.",
evidenceRefs: policyEvidenceRefs,
})];
}
return [requirement({
id: "policy.base_revision",
ruleClass: "policy_integrity",
authority: "patchgate",
source: PATCHGATE_SOURCE,
result: "passed",
severity: "block",
observed: { baseSha: input.revisions.baseSha },
remediation: "Keep the policy source bound to the PR base SHA and its normalized contract digest.",
evidenceRefs: policyEvidenceRefs,
})];
}
function issueRequirements(input: EvaluationInput, policy: PatchgatePolicy): Requirement[] {
if (!policy.issueLinkage?.required) return [];
if (!groupAvailable(input, "linkedIssues")) return [observationRequirement("observation.linked_issues", "linkedIssues", "Retrieve complete, permission-sufficient linked-issue metadata; a body-only issue number is not verified linkage.")];
const linked = input.linkedIssues.filter((issue) => issue.linked);
return [requirement({
id: "issue.linkage",
ruleClass: "issue_linkage",
authority: "patchgate",
source: PATCHGATE_SOURCE,
result: linked.length > 0 ? "passed" : "failed",
severity: "block",
observed: { linkedIssueCount: linked.length },
remediation: "Link at least one valid issue through GitHub metadata; a body-only number is not sufficient evidence.",
evidenceRefs: linked.map((issue) => `issue:${issue.repository}#${issue.number}:${issue.issueId}`),
})];
}
function checkRequirements(input: EvaluationInput, policy: PatchgatePolicy): Requirement[] {
const checksAvailable = groupAvailable(input, "checks");
return (policy.requiredChecks ?? []).map((rule) => {
if (!checksAvailable) return requirement({
id: `check.${rule.id}`,
ruleClass: "required_check",
authority: "patchgate",
source: PATCHGATE_SOURCE,
result: "unknown",
severity: "evidence",
observed: { name: rule.name, resolution: "observation_incomplete" },
remediation: `Retrieve complete check/workflow evidence for ${rule.name} from the configured target revision and expected source.`,
});
const targetSha = rule.target === input.revisions.targetKind ? input.revisions.testedSha : undefined;
const resolution = resolveCheckEvidence(input.checks, rule, targetSha);
const evidence = resolution.status === "passed" || resolution.status === "failed" ? resolution.evidence : undefined;
const result = resolution.status === "passed" ? "passed" : resolution.status === "failed" ? "failed" : "unknown";
const selectedIdentity = evidence === undefined ? {} : {
selectedEvidenceRef: evidenceReference(evidence),
selectedConclusion: evidence.conclusion ?? "",
sourceStrength: evidence.sourceStrength,
...(evidence.appId === undefined ? {} : { appId: evidence.appId }),
...(evidence.checkRunId === undefined ? {} : { checkRunId: evidence.checkRunId }),
...(evidence.workflowId === undefined ? {} : { workflowId: evidence.workflowId }),
...(evidence.workflowPath === undefined ? {} : { workflowPath: evidence.workflowPath }),
...(evidence.workflowRunId === undefined ? {} : { workflowRunId: evidence.workflowRunId }),
...(evidence.workflowRunAttempt === undefined ? {} : { workflowRunAttempt: evidence.workflowRunAttempt }),
...(evidence.event === undefined ? {} : { event: evidence.event }),
};
const expectedIdentity = {
expectedSourceKind: rule.expectedSource.kind,
...(rule.expectedSource.appSlug === undefined ? {} : { expectedAppSlug: rule.expectedSource.appSlug }),
...(rule.expectedSource.appId === undefined ? {} : { expectedAppId: rule.expectedSource.appId }),
...(rule.expectedSource.workflowId === undefined ? {} : { expectedWorkflowId: rule.expectedSource.workflowId }),
...(rule.expectedSource.workflowPath === undefined ? {} : { expectedWorkflowPath: rule.expectedSource.workflowPath }),
...(rule.expectedSource.event === undefined ? {} : { expectedEvent: rule.expectedSource.event }),
};
return requirement({
id: `check.${rule.id}`,
ruleClass: "required_check",
authority: "patchgate",
source: PATCHGATE_SOURCE,
result,
severity: resolution.status === "failed" ? "block" : "evidence",
observed: {
name: rule.name,
target: rule.target,
testedSha: input.revisions.testedSha,
acceptableConclusions: rule.acceptableConclusions,
resolution: resolution.status,
...(resolution.status === "passed" ? {} : { resolutionReason: resolution.reason }),
...expectedIdentity,
...selectedIdentity,
},
remediation: `Provide a completed ${rule.name} check from the expected source on the configured ${rule.target} revision.`,
evidenceRefs: evidence === undefined ? [] : [evidenceReference(evidence)],
});
});
}
type NativeCheckResolution =
| { status: "passed"; evidence: CheckEvidence }
| { status: "failed"; evidence: CheckEvidence; reason: "unacceptable_conclusion" }
| { status: "missing"; reason: "no_candidate" | "wrong_target" | "wrong_source" | "pending" | "unattributed_evidence" }
| { status: "ambiguous"; reason: "duplicate_eligible_candidates" };
function resolveNativeCheckEvidence(checks: readonly CheckEvidence[], context: string, targetSha: string, appId: number | undefined): NativeCheckResolution {
const exactCandidates = checks.filter((check) => check.name === context);
const jobName = context.includes(" / ") ? context.slice(context.lastIndexOf(" / ") + 3) : undefined;
const namedCandidates = exactCandidates.length > 0 ? exactCandidates : jobName === undefined ? [] : checks.filter((check) => check.name === jobName);
if (namedCandidates.length === 0) return { status: "missing", reason: "no_candidate" };
const targetedCandidates = namedCandidates.filter((check) => check.testedSha === targetSha);
if (targetedCandidates.length === 0) return { status: "missing", reason: "wrong_target" };
const sourcedCandidates = appId === undefined ? targetedCandidates : targetedCandidates.filter((check) => check.appId === appId);
if (sourcedCandidates.length === 0) return { status: "missing", reason: "wrong_source" };
if (sourcedCandidates.length > 1) return { status: "ambiguous", reason: "duplicate_eligible_candidates" };
const candidate = sourcedCandidates[0]!;
if (candidate.status !== "completed") return { status: "missing", reason: "pending" };
if (evidenceReference(candidate).length === 0) return { status: "missing", reason: "unattributed_evidence" };
const acceptableConclusions = ["success", "neutral", "skipped"];
if (!acceptableConclusions.includes(candidate.conclusion ?? "")) return { status: "failed", evidence: candidate, reason: "unacceptable_conclusion" };
return { status: "passed", evidence: candidate };
}
interface NativeRequirementSource {
authority: "branch_protection" | "ruleset";
sourceIdentity: string;
idPrefix: string;
requiredChecks: Array<{ context: string; appId?: number | undefined }>;
}
function nativeCheckRequirementsForSource(input: EvaluationInput, source: NativeRequirementSource): Requirement[] {
return source.requiredChecks.map((rule, index) => {
const baseObserved: Record<string, string | number | boolean | string[]> = {
name: rule.context,
context: rule.context,
target: input.revisions.targetKind,
testedSha: input.revisions.testedSha,
acceptableConclusions: ["success", "neutral", "skipped"],
sourceConstraint: rule.appId === undefined ? "unconstrained" : "app_id",
...(rule.appId === undefined ? {} : { expectedAppId: rule.appId }),
};
if (!groupAvailable(input, "checks")) return requirement({ id: `${source.idPrefix}.check.${index + 1}`, ruleClass: "required_check", authority: source.authority, source: source.sourceIdentity, result: "unknown", severity: "evidence", observed: { ...baseObserved, resolution: "observation_incomplete" }, remediation: `Retrieve complete check/workflow evidence for the native context ${rule.context} on ${input.revisions.testedSha}.` });
const resolution = resolveNativeCheckEvidence(input.checks, rule.context, input.revisions.testedSha, rule.appId);
const evidence = resolution.status === "passed" || resolution.status === "failed" ? resolution.evidence : undefined;
const result: RequirementResult = resolution.status === "passed" ? "passed" : resolution.status === "failed" ? "failed" : "unknown";
const selected = evidence === undefined ? {} : {
name: evidence.name,
selectedEvidenceRef: evidenceReference(evidence),
selectedConclusion: evidence.conclusion ?? "",
expectedSourceKind: evidence.sourceStrength,
...(evidence.appId === undefined ? {} : { appId: evidence.appId }),
...(evidence.checkRunId === undefined ? {} : { checkRunId: evidence.checkRunId }),
...(evidence.workflowId === undefined ? {} : { workflowId: evidence.workflowId }),
...(evidence.workflowPath === undefined ? {} : { workflowPath: evidence.workflowPath }),
...(evidence.workflowRunId === undefined ? {} : { workflowRunId: evidence.workflowRunId }),
...(evidence.workflowRunAttempt === undefined ? {} : { workflowRunAttempt: evidence.workflowRunAttempt }),
...(evidence.event === undefined ? {} : { event: evidence.event }),
};
return requirement({
id: `${source.idPrefix}.check.${index + 1}`,
ruleClass: "required_check",
authority: source.authority,
source: source.sourceIdentity,
result,
severity: resolution.status === "failed" ? "block" : "evidence",
observed: { ...baseObserved, resolution: resolution.status, ...(resolution.status === "passed" ? {} : { resolutionReason: resolution.reason }), ...selected },
remediation: rule.appId === undefined
? `Provide a completed ${rule.context} check on ${input.revisions.testedSha}; the native control does not declare a source App, so PatchGate still requires an immutable check/workflow identity.`
: `Provide a completed ${rule.context} check from GitHub App ${rule.appId} on ${input.revisions.testedSha}.`,
evidenceRefs: evidence === undefined ? [] : [evidenceReference(evidence)],
});
});
}
function nativeCheckRequirements(input: EvaluationInput): Requirement[] {
const sources: NativeRequirementSource[] = [];
const branchProtection = input.nativeControls?.branchProtection;
if (branchProtection !== undefined) {
const source = input.policySources.find((candidate) => candidate.kind === "branch_protection");
sources.push({ authority: "branch_protection", sourceIdentity: source?.identity ?? "branch-protection", idPrefix: "native.branch_protection", requiredChecks: branchProtection.requiredChecks });
}
for (const ruleset of input.nativeControls?.rulesets ?? []) {
if (ruleset.enforcement !== "active" || !ruleset.applicable) continue;
const source = input.policySources.find((candidate) => candidate.kind === "ruleset");
sources.push({ authority: "ruleset", sourceIdentity: source?.identity ?? "repository-rulesets", idPrefix: `native.ruleset.${ruleset.id}`, requiredChecks: ruleset.requiredChecks });
}
return sources.flatMap((source) => nativeCheckRequirementsForSource(input, source));
}
function nativeReviewRequirements(input: EvaluationInput): { requirements: Requirement[]; gates: HumanGate[] } {
const branchProtection: NativeBranchProtection | undefined = input.nativeControls?.branchProtection;
if (branchProtection === undefined) return { requirements: [], gates: [] };
const source = input.policySources.find((candidate) => candidate.kind === "branch_protection");
const sourceIdentity = source?.identity ?? "branch-protection";
const requirements: Requirement[] = [];
const gates: HumanGate[] = [];
const addGate = (gateId: string, reason: string, requiredReviewers: string[], requiredCount: number, result: RequirementResult, observed: Record<string, string | number | boolean | string[]>, remediation: string, approvals: ReviewSnapshot[]): void => {
const gate: HumanGate = { id: gateId, reason, satisfied: result === "passed", requiredReviewers, requiredCount, approvedBy: approvals.map((review) => `actor:${review.actorId}`) };
gates.push(gate);
requirements.push(requirement({ id: `handoff.${gateId}`, ruleClass: "human_handoff", authority: "branch_protection", source: sourceIdentity, result, severity: result === "failed" ? "human_gate" : "evidence", observed, remediation, evidenceRefs: approvals.map((review) => `review:${review.reviewId}:actor:${review.actorId}:${review.commitId}`) }));
};
if (branchProtection.requiredApprovals > 0) {
if (!groupAvailable(input, "reviews")) {
addGate("native.branch_protection.required_approvals", `GitHub branch protection requires ${branchProtection.requiredApprovals} approving review(s).`, [], branchProtection.requiredApprovals, "unknown", { requiredCount: branchProtection.requiredApprovals, resolution: "observation_incomplete" }, "Retrieve complete review and reviewer-qualification evidence before evaluating the native approval gate.", []);
} else if (hasUnknownQualification(input.reviews, input.revisions.testedSha, [])) {
addGate("native.branch_protection.required_approvals", `GitHub branch protection requires ${branchProtection.requiredApprovals} approving review(s).`, [], branchProtection.requiredApprovals, "unknown", { requiredCount: branchProtection.requiredApprovals, resolution: "qualification_unavailable" }, "Retrieve sufficient collaborator qualification for current approving reviews before evaluating the native approval gate.", []);
} else {
const approvals = qualifiedApprovals(input.reviews, input.revisions.testedSha, []);
addGate("native.branch_protection.required_approvals", `GitHub branch protection requires ${branchProtection.requiredApprovals} approving review(s).`, [], branchProtection.requiredApprovals, approvals.length >= branchProtection.requiredApprovals ? "passed" : "failed", { requiredCount: branchProtection.requiredApprovals, approvedCount: approvals.length }, `Obtain ${branchProtection.requiredApprovals} active, qualified, non-author approval(s) on ${input.revisions.testedSha}.`, approvals);
}
}
if (branchProtection.requireCodeOwnerReviews) {
if (!groupAvailable(input, "ownership")) {
addGate("native.branch_protection.codeowners", "GitHub branch protection requires review from the applicable CODEOWNERS.", [], 1, "unknown", { resolution: "ownership_observation_incomplete" }, "Retrieve complete CODEOWNERS evidence from the trusted base revision before evaluating the native code-owner gate.", []);
} else {
for (const ownerRule of input.ownershipRequirements) {
const gateId = `native.branch_protection.codeowners.${ownerRule.id}`;
if (hasUnknownQualification(input.reviews, input.revisions.testedSha, ownerRule.owners)) {
addGate(gateId, `GitHub branch protection requires an applicable CODEOWNERS approval for ${ownerRule.id}.`, ownerRule.owners, ownerRule.requiredCount, "unknown", { requiredCount: ownerRule.requiredCount, resolution: "qualification_unavailable" }, `Retrieve sufficient qualification for the configured CODEOWNERS principal(s): ${ownerRule.owners.join(", ")}.`, []);
continue;
}
const approvals = qualifiedApprovals(input.reviews, input.revisions.testedSha, ownerRule.owners);
addGate(gateId, `GitHub branch protection requires an applicable CODEOWNERS approval for ${ownerRule.id}.`, ownerRule.owners, ownerRule.requiredCount, approvals.length >= ownerRule.requiredCount ? "passed" : "failed", { requiredCount: ownerRule.requiredCount, approvedCount: approvals.length }, `Obtain ${ownerRule.requiredCount} active, qualified CODEOWNERS approval(s) for ${ownerRule.id}.`, approvals);
}
}
}
if (branchProtection.requireLastPushApproval) {
addGate("native.branch_protection.last_push_approval", "GitHub branch protection requires approval from someone other than the last pusher.", [], 1, "unknown", { resolution: "last_pusher_identity_unavailable" }, "Provide immutable last-pusher identity evidence before evaluating this native control; the current PR snapshot does not include it.", []);
}
return { requirements, gates };
}
function nativeRulesetReviewRequirements(input: EvaluationInput): { requirements: Requirement[]; gates: HumanGate[] } {
const requirements: Requirement[] = [];
const gates: HumanGate[] = [];
const source = input.policySources.find((candidate) => candidate.kind === "ruleset");
const sourceIdentity = source?.identity ?? "repository-rulesets";
const addGate = (rulesetId: number, gateSuffix: string, reason: string, requiredReviewers: string[], requiredCount: number, result: RequirementResult, observed: Record<string, string | number | boolean | string[]>, remediation: string, approvals: ReviewSnapshot[]): void => {
const gateId = `native.ruleset.${rulesetId}.${gateSuffix}`;
gates.push({ id: gateId, reason, satisfied: result === "passed", requiredReviewers, requiredCount, approvedBy: approvals.map((review) => `actor:${review.actorId}`) });
requirements.push(requirement({ id: `handoff.${gateId}`, ruleClass: "human_handoff", authority: "ruleset", source: sourceIdentity, result, severity: result === "failed" ? "human_gate" : "evidence", observed, remediation, evidenceRefs: approvals.map((review) => `review:${review.reviewId}:actor:${review.actorId}:${review.commitId}`) }));
};
for (const ruleset of input.nativeControls?.rulesets ?? []) {
if (ruleset.enforcement !== "active" || !ruleset.applicable) continue;
if (ruleset.requiredApprovals > 0) {
if (!groupAvailable(input, "reviews")) addGate(ruleset.id, "required_approvals", `Ruleset ${ruleset.name} requires ${ruleset.requiredApprovals} approving review(s).`, [], ruleset.requiredApprovals, "unknown", { requiredCount: ruleset.requiredApprovals, resolution: "observation_incomplete" }, "Retrieve complete review and reviewer-qualification evidence before evaluating the ruleset approval gate.", []);
else if (hasUnknownQualification(input.reviews, input.revisions.testedSha, [])) addGate(ruleset.id, "required_approvals", `Ruleset ${ruleset.name} requires ${ruleset.requiredApprovals} approving review(s).`, [], ruleset.requiredApprovals, "unknown", { requiredCount: ruleset.requiredApprovals, resolution: "qualification_unavailable" }, "Retrieve sufficient collaborator qualification for current approving reviews before evaluating the ruleset approval gate.", []);
else {
const approvals = qualifiedApprovals(input.reviews, input.revisions.testedSha, []);
addGate(ruleset.id, "required_approvals", `Ruleset ${ruleset.name} requires ${ruleset.requiredApprovals} approving review(s).`, [], ruleset.requiredApprovals, approvals.length >= ruleset.requiredApprovals ? "passed" : "failed", { requiredCount: ruleset.requiredApprovals, approvedCount: approvals.length }, `Obtain ${ruleset.requiredApprovals} active, qualified, non-author approval(s) on ${input.revisions.testedSha}.`, approvals);
}
}
if (ruleset.requireCodeOwnerReviews) {
if (!groupAvailable(input, "ownership")) addGate(ruleset.id, "codeowners", `Ruleset ${ruleset.name} requires applicable CODEOWNERS approval.`, [], 1, "unknown", { resolution: "ownership_observation_incomplete" }, "Retrieve complete CODEOWNERS evidence from the trusted base revision before evaluating the ruleset code-owner gate.", []);
else for (const ownerRule of input.ownershipRequirements) {
const reason = `Ruleset ${ruleset.name} requires applicable CODEOWNERS approval for ${ownerRule.id}.`;
if (hasUnknownQualification(input.reviews, input.revisions.testedSha, ownerRule.owners)) addGate(ruleset.id, `codeowners.${ownerRule.id}`, reason, ownerRule.owners, ownerRule.requiredCount, "unknown", { requiredCount: ownerRule.requiredCount, resolution: "qualification_unavailable" }, `Retrieve sufficient qualification for the configured CODEOWNERS principal(s): ${ownerRule.owners.join(", ")}.`, []);
else {
const approvals = qualifiedApprovals(input.reviews, input.revisions.testedSha, ownerRule.owners);
addGate(ruleset.id, `codeowners.${ownerRule.id}`, reason, ownerRule.owners, ownerRule.requiredCount, approvals.length >= ownerRule.requiredCount ? "passed" : "failed", { requiredCount: ownerRule.requiredCount, approvedCount: approvals.length }, `Obtain ${ownerRule.requiredCount} active, qualified CODEOWNERS approval(s) for ${ownerRule.id}.`, approvals);
}
}
}
if (ruleset.requireLastPushApproval) addGate(ruleset.id, "last_push_approval", `Ruleset ${ruleset.name} requires approval from someone other than the last pusher.`, [], 1, "unknown", { resolution: "last_pusher_identity_unavailable" }, "Provide immutable last-pusher identity evidence before evaluating this ruleset control.", []);
if (ruleset.requiredReviewThreadResolution) addGate(ruleset.id, "review_thread_resolution", `Ruleset ${ruleset.name} requires all review threads to be resolved.`, [], 1, "unknown", { resolution: "review_thread_observation_unavailable" }, "Provide complete review-thread resolution evidence before evaluating this ruleset control.", []);
}
return { requirements, gates };
}
function ownershipRequirements(input: EvaluationInput, policy: PatchgatePolicy): Requirement[] {
if (!policy.ownership?.requireCodeOwnerApproval) return [];
if (!hasBasePolicySource(input, "codeowners")) return [observationRequirement("ownership.observation", "ownership", "Retrieve the complete CODEOWNERS-derived ownership requirement from the trusted base revision and record its source identity.")];
if (!groupAvailable(input, "ownership")) return [observationRequirement("ownership.observation", "ownership", "Retrieve complete CODEOWNERS-derived ownership requirements from the trusted base revision.")];
if (input.ownershipRequirements.length === 0) return [requirement({
id: "ownership.no_match",
ruleClass: "ownership",
authority: "codeowners",
source: "CODEOWNERS@base",
result: "passed",
severity: "human_gate",
observed: { ownershipRequirementCount: 0 },
remediation: "Retain the complete base CODEOWNERS observation proving that no ownership rule matched the changed paths.",
evidenceRefs: ["observation:ownership"],
})];
if (!groupAvailable(input, "reviews")) return [observationRequirement("reviews.observation", "reviews", "Retrieve complete review and reviewer-qualification metadata before evaluating ownership approval.")];
if (hasUnknownQualification(input.reviews, input.revisions.testedSha, input.ownershipRequirements.flatMap((item) => item.owners))) return [observationRequirement("reviews.qualification", "reviews", "Retrieve immutable actor/team qualification and sufficient permission before evaluating ownership approval.")];
return input.ownershipRequirements.map((ownerRule) => {
const approvals = qualifiedApprovals(input.reviews, input.revisions.testedSha, ownerRule.owners);
const passed = approvals.length >= ownerRule.requiredCount;
return requirement({
id: `ownership.${ownerRule.id}`,
ruleClass: "ownership",
authority: "codeowners",
source: "CODEOWNERS@base",
result: passed ? "passed" : "failed",
severity: "human_gate",
observed: { requiredCount: ownerRule.requiredCount, approvedCount: approvals.length },
remediation: `Obtain ${ownerRule.requiredCount} active, qualified CODEOWNERS approval on ${input.revisions.testedSha}.`,
evidenceRefs: approvals.map((review) => `review:${review.reviewId}:actor:${review.actorId}:${review.commitId}`),
});
});
}
function humanHandoffRequirements(input: EvaluationInput, policy: PatchgatePolicy): { requirements: Requirement[]; gates: HumanGate[] } {
const requirements: Requirement[] = [];
const gates: HumanGate[] = [];
if (!groupAvailable(input, "changedPaths")) {
return { requirements: [observationRequirement("changed_paths.observation", "changedPaths", "Retrieve the complete changed-path collection before deciding policy-change or sensitive-path matches.")], gates };
}
for (const rule of policy.sensitivePaths ?? []) {
if (!matchedPath(input.changedPaths, rule.patterns)) continue;
if (!groupAvailable(input, "reviews")) {
requirements.push(requirement({ id: `handoff.${rule.id}`, ruleClass: "human_handoff", authority: "patchgate", source: PATCHGATE_SOURCE, result: "unknown", severity: "evidence", observed: { matched: true, requiredCount: rule.requiredCount, resolution: "reviews_unavailable" }, remediation: `Retrieve complete qualified-review evidence for sensitive path rule ${rule.id}.` }));
gates.push({ id: rule.id, reason: `Sensitive path rule matched: ${[...rule.patterns].sort().join(", ")}`, satisfied: false, requiredReviewers: rule.requiredReviewers, requiredCount: rule.requiredCount, approvedBy: [] });
continue;
}
if (hasUnknownQualification(input.reviews, input.revisions.testedSha, rule.requiredReviewers)) {
requirements.push(requirement({ id: `handoff.${rule.id}`, ruleClass: "human_handoff", authority: "patchgate", source: PATCHGATE_SOURCE, result: "unknown", severity: "evidence", observed: { matched: true, requiredCount: rule.requiredCount, resolution: "qualification_unavailable" }, remediation: `Retrieve immutable reviewer/team qualification evidence for sensitive path rule ${rule.id}.` }));
gates.push({ id: rule.id, reason: `Sensitive path rule matched: ${[...rule.patterns].sort().join(", ")}`, satisfied: false, requiredReviewers: rule.requiredReviewers, requiredCount: rule.requiredCount, approvedBy: [] });
continue;
}
const approvals = qualifiedApprovals(input.reviews, input.revisions.testedSha, rule.requiredReviewers);
const satisfied = approvals.length >= rule.requiredCount;
const gate: HumanGate = { id: rule.id, reason: `Sensitive path rule matched: ${[...rule.patterns].sort().join(", ")}`, satisfied, requiredReviewers: rule.requiredReviewers, requiredCount: rule.requiredCount, approvedBy: approvals.map((review) => `actor:${review.actorId}`) };
gates.push(gate);
requirements.push(requirement({ id: `handoff.${rule.id}`, ruleClass: "human_handoff", authority: "patchgate", source: PATCHGATE_SOURCE, result: satisfied ? "passed" : "failed", severity: rule.humanGate ? "human_gate" : "block", observed: { matched: true, requiredCount: rule.requiredCount, approvedCount: approvals.length }, remediation: `Obtain the configured human approval for ${rule.id}; PatchGate cannot force an agent to stop.`, evidenceRefs: approvals.map((review) => `review:${review.reviewId}:actor:${review.actorId}:${review.commitId}`) }));
}
if (policy.policyChanges !== undefined) {
if (!matchedPath(input.changedPaths, changedPolicyPaths(input, policy))) return { requirements, gates };
const result: RequirementResult = policy.policyChanges.mode === "advisory" ? "advisory" : "failed";
requirements.push(requirement({ id: "policy.change", ruleClass: "human_handoff", authority: "patchgate", source: PATCHGATE_SOURCE, result, severity: policy.policyChanges.mode === "blocked" ? "block" : "human_gate", observed: { changedPaths: input.changedPaths }, remediation: "Review and merge the policy change under the trusted base policy; it cannot relax its own PR evaluation.", evidenceRefs: ["observation:changedPaths"] }));
}
return { requirements, gates };
}
function reviewabilityRequirements(input: EvaluationInput, policy: PatchgatePolicy): Requirement[] {
if (policy.reviewability === undefined) return [];
if (!groupAvailable(input, "reviewability")) {
return [requirement({ id: "reviewability.snapshot", ruleClass: "reviewability", authority: "patchgate", source: PATCHGATE_SOURCE, result: policy.reviewability.mode === "advisory" ? "advisory" : "unknown", severity: policy.reviewability.mode === "advisory" ? "advisory" : "evidence", remediation: "Provide a complete reviewability snapshot for the configured mode." })];
}
if (input.reviewability === undefined) {
return [requirement({ id: "reviewability.snapshot", ruleClass: "reviewability", authority: "patchgate", source: PATCHGATE_SOURCE, result: policy.reviewability.mode === "advisory" ? "advisory" : "unknown", severity: policy.reviewability.mode === "advisory" ? "advisory" : "evidence", remediation: "Provide a normalized reviewability snapshot from the trusted adapter." })];
}
const snapshot = input.reviewability;
const checks: Array<[string, number | undefined, number, string]> = [
["files", policy.reviewability.budgets.maxFiles, snapshot.fileCount, "files"],
["ownership_domains", policy.reviewability.budgets.maxOwnershipDomains, snapshot.ownershipDomains.length, "ownership domains"],
["generated_files", policy.reviewability.budgets.maxGeneratedFiles, snapshot.generatedFileCount, "generated files"],
["boundaries", policy.reviewability.budgets.maxBoundaries, snapshot.boundaryCount, "subsystem boundaries"],
];
return checks.filter(([, limit]) => limit !== undefined).map(([name, limit, actual, label]) => {
const passed = actual <= (limit as number);
return requirement({ id: `reviewability.${name}`, ruleClass: "reviewability", authority: "patchgate", source: PATCHGATE_SOURCE, result: passed ? "passed" : policy.reviewability?.mode === "blocking" ? "failed" : "advisory", severity: policy.reviewability?.mode === "blocking" ? "block" : "advisory", observed: { actual, limit: limit as number }, remediation: `Keep ${label} at or below ${limit as number}, or split the contribution and document the boundary.`, evidenceRefs: ["observation:reviewability"] });
});
}
export function evaluateValidated(input: EvaluationInput): ContributionReceiptCore {
const requirements = policyRequirements(input);
const handoff: { requirements: Requirement[]; gates: HumanGate[] } = { requirements: [], gates: [] };
requirements.push(...nativeCheckRequirements(input));
const nativeHandoff = nativeReviewRequirements(input);
handoff.requirements.push(...nativeHandoff.requirements);
handoff.gates.push(...nativeHandoff.gates);
const nativeRulesetHandoff = nativeRulesetReviewRequirements(input);
handoff.requirements.push(...nativeRulesetHandoff.requirements);
handoff.gates.push(...nativeRulesetHandoff.gates);
if (input.policy !== null && hasPatchgateSource(input)) {
requirements.push(...issueRequirements(input, input.policy));
requirements.push(...checkRequirements(input, input.policy));
requirements.push(...ownershipRequirements(input, input.policy));
const calculatedHandoff = humanHandoffRequirements(input, input.policy);
handoff.requirements.push(...calculatedHandoff.requirements);
handoff.gates.push(...calculatedHandoff.gates);
requirements.push(...reviewabilityRequirements(input, input.policy));
}
const orderedRequirements = [...requirements, ...handoff.requirements].sort(compareIds);
const core: ContributionReceiptCore = structuredClone({
schemaVersion: "0.1",
evaluatorVersion: EVALUATOR_VERSION,
repository: input.repository,
revisions: input.revisions,
policyDigest: input.policyDigest,
decisionInputDigest: decisionInputDigest(input),
receiptDigest: "sha256:" + "0".repeat(64),
changedPaths: input.changedPaths,
policySources: input.policySources,
observations: input.observations,
// Included so a receipt consumer can recompute decisionInputDigest, which
// hashes the full input including native controls.
...(input.nativeControls === undefined ? {} : { nativeControls: input.nativeControls }),
evidence: { checks: input.checks, linkedIssues: input.linkedIssues, reviews: input.reviews, ownershipRequirements: input.ownershipRequirements },
requirements: orderedRequirements,
...(input.reviewability === undefined ? {} : { reviewability: input.reviewability }),
humanGates: handoff.gates.sort(compareIds),
final: { status: determineFinalStatus(orderedRequirements), reasonIds: orderedRequirements.filter((item) => item.result !== "passed").map((item) => item.id) },
});
return { ...core, receiptDigest: calculateReceiptDigest(core) };
}
export function deliverReceipt(core: ContributionReceiptCore, evaluatedAt: string): ContributionReceiptCore & { evaluatedAt: string } {
return { ...structuredClone(core), evaluatedAt };
}