Repository navigation
Expand file tree
/
Copy pathpull_request_target_validation_test.go
More file actions
489 lines (458 loc) · 11.4 KB
/
Copy pathpull_request_target_validation_test.go
File metadata and controls
489 lines (458 loc) · 11.4 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
//go:build !integration
package workflow
import (
"os"
"path/filepath"
"strings"
"testing"
"github.com/github/gh-aw/pkg/testutil"
)
// TestPullRequestTargetValidation tests security validation for the pull_request_target trigger.
func TestPullRequestTargetValidation(t *testing.T) {
tmpDir := testutil.TempDir(t, "prt-validation-test")
tests := []struct {
name string
frontmatter string
filename string
strictMode bool
expectError bool
expectWarning bool
errorContains string
warningCount int
}{
// ---- non-strict mode ----
{
name: "pull_request_target with checkout disabled - non-strict - no warning",
frontmatter: `---
strict: false
on:
pull_request_target:
types: [opened]
tools:
github: false
features:
dangerously-disable-sandbox-agent: true
sandbox:
agent: false
checkout: false
---
# PR Target Workflow
Test workflow content.`,
filename: "prt-checkout-false-non-strict.md",
strictMode: false,
expectError: false,
expectWarning: false,
warningCount: 0,
},
{
name: "pull_request_target with no checkout key - non-strict - insecure checkout warning",
frontmatter: `---
strict: false
on:
pull_request_target:
types: [opened]
tools:
github: false
features:
dangerously-disable-sandbox-agent: true
sandbox:
agent: false
---
# PR Target Workflow
Test workflow content.`,
filename: "prt-checkout-enabled-non-strict.md",
strictMode: false,
expectError: false,
expectWarning: true,
warningCount: 1, // insecure-checkout warning (non-strict mode)
},
{
name: "pull_request_target with trusted checkout - non-strict - no warnings no error",
frontmatter: `---
strict: false
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
repository: ${{ github.repository }}
ref: ${{ github.event.pull_request.base.sha }}
---
# PR Target Non-Strict Trusted Checkout
Test workflow content.`,
filename: "prt-checkout-trusted-non-strict.md",
strictMode: false,
expectError: false,
expectWarning: false,
warningCount: 0,
},
{
name: "pull_request trigger (not target) - non-strict - no diagnostic",
frontmatter: `---
strict: false
on:
pull_request:
types: [opened]
tools:
github: false
features:
dangerously-disable-sandbox-agent: true
sandbox:
agent: false
---
# PR Workflow
Test workflow content.`,
filename: "pr-non-strict.md",
strictMode: false,
expectError: false,
expectWarning: false,
warningCount: 0,
},
{
name: "push trigger - non-strict - no diagnostic",
frontmatter: `---
strict: false
on:
push:
branches: [main]
tools:
github: false
features:
dangerously-disable-sandbox-agent: true
sandbox:
agent: false
---
# Push Workflow
Test workflow content.`,
filename: "push-non-strict.md",
strictMode: false,
expectError: false,
expectWarning: false,
warningCount: 0,
},
// ---- strict mode ----
{
name: "pull_request_target with checkout disabled - strict - dangerous-trigger warning",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout: false
---
# PR Target Strict Workflow
Test workflow content.`,
filename: "prt-checkout-false-strict.md",
strictMode: true,
expectError: false,
expectWarning: true,
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with no checkout key - strict - insecure checkout error",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
---
# PR Target Strict No Checkout
Test workflow content.`,
filename: "prt-checkout-enabled-strict.md",
strictMode: true,
expectError: true,
expectWarning: true,
errorContains: "pull_request_target trigger with checkout enabled is extremely insecure",
warningCount: 1, // dangerous-trigger warning; insecure-checkout is returned as an error
},
{
name: "pull_request_target with explicit checkout pinned to base sha - strict - warning only",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
repository: ${{ github.repository }}
ref: ${{ github.event.pull_request.base.sha }}
---
# PR Target Strict Trusted Checkout
Test workflow content.`,
filename: "prt-checkout-base-sha-strict.md",
strictMode: true,
expectError: false,
expectWarning: true,
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with explicit checkout default ref in base repo - strict - warning only",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
repository: ${{ github.repository }}
sparse-checkout: |
.github
---
# PR Target Strict Trusted Default Ref
Test workflow content.`,
filename: "prt-checkout-base-repo-default-ref-strict.md",
strictMode: true,
expectError: false,
expectWarning: true,
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with trusted checkout expressions using compact syntax - strict - warning only",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
repository: ${{github.repository}}
ref: ${{github.event.pull_request.base.sha}}
---
# PR Target Strict Trusted Compact Expressions
Test workflow content.`,
filename: "prt-checkout-trusted-compact-expr-strict.md",
strictMode: true,
expectError: false,
expectWarning: true,
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with explicit checkout pinned to base ref expression - strict - warning only",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
repository: ${{ github.repository }}
ref: ${{ github.event.pull_request.base.ref }}
---
# PR Target Strict Trusted Base Ref
Test workflow content.`,
filename: "prt-checkout-base-ref-strict.md",
strictMode: true,
expectError: false,
expectWarning: true,
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with unwrapped trusted-looking ref string - strict - still errors",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
repository: ${{ github.repository }}
ref: github.event.pull_request.base.sha
---
# PR Target Strict Unwrapped Ref String
Test workflow content.`,
filename: "prt-checkout-unwrapped-ref-string-strict.md",
strictMode: true,
expectError: true,
expectWarning: true,
errorContains: "pull_request_target trigger with checkout enabled is extremely insecure",
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with mixed trusted and untrusted checkouts - strict - errors",
frontmatter: `---
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
checkout:
- repository: ${{ github.repository }}
ref: ${{ github.event.pull_request.base.sha }}
- repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.sha }}
---
# PR Target Mixed Checkouts
Test workflow content.`,
filename: "prt-checkout-mixed-strict.md",
strictMode: true,
expectError: true,
expectWarning: true,
errorContains: "pull_request_target trigger with checkout enabled is extremely insecure",
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request_target with no checkout key - strict CLI overrides frontmatter strict false",
frontmatter: `---
strict: false
on:
pull_request_target:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
---
# PR Target Strict Opt-Out
Test workflow content.`,
filename: "prt-checkout-enabled-strict-frontmatter-opt-out.md",
strictMode: true,
expectError: true,
expectWarning: true,
errorContains: "pull_request_target trigger with checkout enabled is extremely insecure",
warningCount: 1, // dangerous-trigger warning
},
{
name: "pull_request trigger (not target) - strict - no diagnostic",
frontmatter: `---
on:
pull_request:
types: [opened]
tools:
github:
toolsets: [pull_requests]
permissions:
pull-requests: read
---
# PR Strict Workflow
Test workflow content.`,
filename: "pr-strict.md",
strictMode: true,
expectError: false,
expectWarning: false,
warningCount: 0,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
mdFile := filepath.Join(tmpDir, tt.filename)
if err := os.WriteFile(mdFile, []byte(tt.frontmatter), 0644); err != nil {
t.Fatal(err)
}
compiler := NewCompiler()
compiler.SetStrictMode(tt.strictMode)
compiler.SetNoEmit(true)
err := compiler.CompileWorkflow(mdFile)
if tt.expectError {
if err == nil {
t.Errorf("Expected error but got none")
} else if tt.errorContains != "" && !strings.Contains(err.Error(), tt.errorContains) {
t.Errorf("Expected error to contain %q but got: %v", tt.errorContains, err)
}
} else {
if err != nil {
t.Errorf("Unexpected error: %v", err)
}
}
if compiler.GetWarningCount() != tt.warningCount {
t.Errorf("Expected %d warnings but got %d", tt.warningCount, compiler.GetWarningCount())
}
})
}
}
func TestMatchesGitHubExpression(t *testing.T) {
t.Parallel()
assertions := []struct {
name string
value string
expected string
match bool
}{
{
name: "spaced expression",
value: "${{ github.repository }}",
expected: "github.repository",
match: true,
},
{
name: "compact expression",
value: "${{github.repository}}",
expected: "github.repository",
match: true,
},
{
name: "base sha expression matches",
value: "${{ github.event.pull_request.base.sha }}",
expected: "github.event.pull_request.base.sha",
match: true,
},
{
name: "base ref expression matches",
value: "${{ github.event.pull_request.base.ref }}",
expected: "github.event.pull_request.base.ref",
match: true,
},
{
name: "head sha expression does not match base sha",
value: "${{ github.event.pull_request.head.sha }}",
expected: "github.event.pull_request.base.sha",
match: false,
},
{
name: "missing closing braces",
value: "${{ github.repository",
expected: "github.repository",
match: false,
},
{
name: "empty expression",
value: "${{}}",
expected: "github.repository",
match: false,
},
{
name: "extra trailing tokens",
value: "${{ github.repository }}bar}}",
expected: "github.repository",
match: false,
},
}
for _, tc := range assertions {
t.Run(tc.name, func(t *testing.T) {
actual := matchesGitHubExpression(tc.value, tc.expected)
if actual != tc.match {
t.Fatalf("matchesGitHubExpression(%q, %q) = %v, want %v", tc.value, tc.expected, actual, tc.match)
}
})
}
}