-
Notifications
You must be signed in to change notification settings - Fork 250
/
artifacts_multiuser_test.go
390 lines (351 loc) · 11.9 KB
/
artifacts_multiuser_test.go
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
//go:build multiuser
package main
import (
"encoding/base64"
"encoding/json"
"fmt"
"os"
"path/filepath"
"reflect"
"testing"
"time"
"github.com/mcuadros/go-defaults"
tcclient "github.com/taskcluster/taskcluster/v58/clients/client-go"
"github.com/taskcluster/taskcluster/v58/workers/generic-worker/fileutil"
"golang.org/x/crypto/ed25519"
)
func TestChainOfTrustUpload(t *testing.T) {
setup(t)
expires := tcclient.Time(time.Now().Add(time.Minute * 30))
command := helloGoodbye()
command = append(command, copyTestdataFile("SampleArtifacts/_/X.txt")...)
command = append(command, copyTestdataFile("SampleArtifacts/b/c/d.jpg")...)
payload := GenericWorkerPayload{
Command: command,
MaxRunTime: 30,
Artifacts: []Artifact{
{
Path: "SampleArtifacts/_/X.txt",
Expires: expires,
Type: "file",
Name: "public/build/X.txt",
},
{
Path: "SampleArtifacts/b/c/d.jpg",
Expires: expires,
Type: "file",
},
},
Features: FeatureFlags{
ChainOfTrust: true,
},
}
defaults.SetDefaults(&payload)
td := testTask(t)
// Chain of trust is not allowed when running as current user
// since signing key cannot be secured
if config.RunTasksAsCurrentUser {
expectChainOfTrustKeyNotSecureMessage(t, td, payload)
return
}
taskID := submitAndAssert(t, td, payload, "completed", "completed")
// some required substrings - not all, just a selection
expectedArtifacts := ExpectedArtifacts{
"public/logs/live_backing.log": {
Extracts: []string{
"hello world!",
"goodbye world!",
},
ContentType: "text/plain; charset=utf-8",
ContentEncoding: "gzip",
Expires: td.Expires,
},
"public/logs/live.log": {
Extracts: []string{
"hello world!",
"goodbye world!",
"=== Task Finished ===",
"Exit Code: 0",
},
ContentType: "text/plain; charset=utf-8",
ContentEncoding: "gzip",
Expires: td.Expires,
},
"public/logs/certified.log": {
Extracts: []string{
"hello world!",
"goodbye world!",
"=== Task Finished ===",
"Exit Code: 0",
},
ContentType: "text/plain; charset=utf-8",
ContentEncoding: "gzip",
Expires: td.Expires,
},
"public/chain-of-trust.json": {
// e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 ./%%%/v/X
// 8308d593eb56527137532595a60255a3fcfbe4b6b068e29b22d99742bad80f6f ./_/X.txt
// a0ed21ab50992121f08da55365da0336062205fd6e7953dbff781a7de0d625b7 ./b/c/d.jpg
Extracts: []string{
"8308d593eb56527137532595a60255a3fcfbe4b6b068e29b22d99742bad80f6f",
},
ContentType: "text/plain; charset=utf-8",
ContentEncoding: "gzip",
Expires: td.Expires,
},
"public/chain-of-trust.json.sig": {
ContentType: "application/octet-stream",
ContentEncoding: "gzip",
Expires: td.Expires,
},
"public/build/X.txt": {
Extracts: []string{
"test artifact",
},
ContentType: "text/plain; charset=utf-8",
ContentEncoding: "gzip",
Expires: payload.Artifacts[0].Expires,
},
"SampleArtifacts/b/c/d.jpg": {
Extracts: []string{},
ContentType: "image/jpeg",
ContentEncoding: "identity", // jpg files are blacklisted against gzip compression
Expires: payload.Artifacts[0].Expires,
},
}
expectedArtifacts.Validate(t, taskID, 0)
cotUnsignedBytes := getArtifactContent(t, taskID, "public/chain-of-trust.json")
var cotCert ChainOfTrustData
err := json.Unmarshal(cotUnsignedBytes, &cotCert)
if err != nil {
t.Fatalf("Could not interpret public/chain-of-trust.json as json")
}
cotSignature := getArtifactContent(t, taskID, "public/chain-of-trust.json.sig")
var ed25519Pubkey ed25519.PublicKey
base64Ed25519Pubkey, err := os.ReadFile(filepath.Join("testdata", "ed25519_public_key"))
if err != nil {
t.Fatalf("Error opening ed25519 public key file")
}
ed25519Pubkey, err = base64.StdEncoding.DecodeString(string(base64Ed25519Pubkey))
if err != nil {
t.Fatalf("Error converting ed25519 public key to a valid pubkey")
}
ed25519Verified := ed25519.Verify(ed25519Pubkey, cotUnsignedBytes, cotSignature)
if ed25519Verified != true {
t.Fatalf("Could not verify public/chain-of-trust.json.sig signature against public/chain-of-trust.json")
}
// Read the task back from the queue for validation
queue := serviceFactory.Queue(config.Credentials(), config.RootURL)
tdRes, err := queue.Task(taskID)
if err != nil {
t.Fatalf("Cannot get task %v from the queue", taskID)
}
// The Payload, Tags and Extra fields are raw bytes, so differences may not
// be valid. Since we are comparing the rest, let's skip these three fields,
// as the rest should give us good enough coverage already.
cotCert.Task.Payload = nil
cotCert.Task.Tags = nil
cotCert.Task.Extra = nil
tdRes.Payload = nil
tdRes.Tags = nil
tdRes.Extra = nil
if !reflect.DeepEqual(cotCert.Task, *tdRes) {
t.Fatalf("Did not get back expected task definition in chain of trust certificate:\n%#v\n ** vs **\n%#v", cotCert.Task, tdRes)
}
if len(cotCert.Artifacts) != 3 {
t.Fatalf("Expected 3 artifact hashes to be listed, but found %v", len(cotCert.Artifacts))
}
if cotCert.TaskID != taskID {
t.Fatalf("Expected taskId to be %q but was %q", taskID, cotCert.TaskID)
}
if cotCert.RunID != 0 {
t.Fatalf("Expected runId to be 0 but was %v", cotCert.RunID)
}
if cotCert.WorkerGroup != "test-worker-group" {
t.Fatalf("Expected workerGroup to be \"test-worker-group\" but was %q", cotCert.WorkerGroup)
}
if cotCert.WorkerID != "test-worker-id" {
t.Fatalf("Expected workerGroup to be \"test-worker-id\" but was %q", cotCert.WorkerID)
}
if cotCert.Environment.PublicIPAddress != "12.34.56.78" {
t.Fatalf("Expected publicIpAddress to be 12.34.56.78 but was %v", cotCert.Environment.PublicIPAddress)
}
if cotCert.Environment.PrivateIPAddress != "87.65.43.21" {
t.Fatalf("Expected privateIpAddress to be 87.65.43.21 but was %v", cotCert.Environment.PrivateIPAddress)
}
if cotCert.Environment.InstanceID != "test-instance-id" {
t.Fatalf("Expected instanceId to be \"test-instance-id\" but was %v", cotCert.Environment.InstanceID)
}
if cotCert.Environment.InstanceType != "p3.enormous" {
t.Fatalf("Expected instanceType to be \"p3.enormous\" but was %v", cotCert.Environment.InstanceType)
}
if cotCert.Environment.Region != "test-worker-group" {
t.Fatalf("Expected region to be \"test-worker-group\" but was %v", cotCert.Environment.Region)
}
// Check artifact list in CoT includes the names (not paths) of all
// expected artifacts...
// blacklist is for artifacts that by design should not be included in
// chain of trust artifact list
blacklist := map[string]bool{
"public/logs/live.log": true,
"public/logs/live_backing.log": true,
"public/chain-of-trust.json": true,
"public/chain-of-trust.json.sig": true,
}
for artifactName := range expectedArtifacts {
if _, inBlacklist := blacklist[artifactName]; !inBlacklist {
if _, inCotManifest := cotCert.Artifacts[artifactName]; !inCotManifest {
t.Fatalf("Artifact not listed in chain of trust manifest: %v", artifactName)
}
}
}
}
func TestProtectedArtifactsReplaced(t *testing.T) {
setup(t)
expires := tcclient.Time(time.Now().Add(time.Minute * 30))
command := helloGoodbye()
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/logs/live.log")...)
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/logs/live_backing.log")...)
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/logs/certified.log")...)
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/chain-of-trust.json")...)
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/chain-of-trust.json.sig")...)
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/X.txt")...)
command = append(command, copyTestdataFileTo("SampleArtifacts/_/X.txt", "public/Y.txt")...)
payload := GenericWorkerPayload{
Command: command,
MaxRunTime: 30,
Artifacts: []Artifact{
{
Path: "public/logs/live.log",
Expires: expires,
Type: "file",
},
{
Path: "public/logs/live_backing.log",
Expires: expires,
Type: "file",
},
{
Path: "public/logs/certified.log",
Expires: expires,
Type: "file",
},
{
Path: "public/chain-of-trust.json",
Expires: expires,
Type: "file",
},
{
Path: "public/chain-of-trust.json.sig",
Expires: expires,
Type: "file",
},
{
Path: "public/X.txt",
Expires: expires,
Type: "file",
},
{
Path: "public/Y.txt",
Expires: expires,
Type: "file",
},
},
Features: FeatureFlags{
ChainOfTrust: true,
},
}
defaults.SetDefaults(&payload)
td := testTask(t)
// Chain of trust is not allowed when running as current user
// since signing key cannot be secured
if config.RunTasksAsCurrentUser {
expectChainOfTrustKeyNotSecureMessage(t, td, payload)
return
}
taskID := submitAndAssert(t, td, payload, "completed", "completed")
queue := serviceFactory.Queue(nil, config.RootURL)
artifacts, err := queue.ListArtifacts(taskID, "0", "", "")
if err != nil {
t.Fatalf("Error listing artifacts: %v", err)
}
if l := len(artifacts.Artifacts); l != 7 {
t.Fatalf("Was expecting 7 artifacts, but got %v", l)
}
// use the artifact names as keys in a map, so we can look up that each key exists
a := map[string]bool{}
for _, j := range artifacts.Artifacts {
a[j.Name] = true
}
x := getArtifactContent(t, taskID, "public/X.txt")
y := getArtifactContent(t, taskID, "public/Y.txt")
if string(x) != string(y) {
t.Fatalf("Artifacts X.txt and Y.txt should have identical content in task %v, but they do not", taskID)
}
for _, artifactName := range []string{
"public/logs/live.log",
"public/logs/live_backing.log",
"public/logs/certified.log",
"public/chain-of-trust.json",
"public/chain-of-trust.json.sig",
} {
if !a[artifactName] {
t.Fatalf("Artifact %v missing in task %v", artifactName, taskID)
}
// make sure artifact content isn't from copied file
b := getArtifactContent(t, taskID, artifactName)
if string(b) == string(x) {
t.Fatalf("Protected artifact %v seems to have overridden content from X.txt in task %v", artifactName, taskID)
}
}
}
func TestPrivilegedFileUpload(t *testing.T) {
// This test shouldn't use an external taskcluster instance,
// as it depends on an updated queue service.
// Otherwise, the test will run into a schema validation
// failure due to fact that the post-artifact-request.yml
// schema on Community-TC doesn't have "file-not-readable-on-worker"
// reason as a valid option during the development of PR #6673.
useExternalTC := os.Getenv("GW_TESTS_USE_EXTERNAL_TASKCLUSTER")
err := os.Unsetenv("GW_TESTS_USE_EXTERNAL_TASKCLUSTER")
if err != nil {
t.Fatalf("Could not unset the GW_TESTS_USE_EXTERNAL_TASKCLUSTER environment variable: %v", err)
}
defer func() {
err := os.Setenv("GW_TESTS_USE_EXTERNAL_TASKCLUSTER", useExternalTC)
if err != nil {
t.Fatalf("Could not set the GW_TESTS_USE_EXTERNAL_TASKCLUSTER environment variable back to original value: %v", err)
}
}()
setup(t)
tempFile, err := os.CreateTemp(testdataDir, t.Name())
if err != nil {
t.Fatalf("Could not create temporary file: %v", err)
}
defer os.Remove(tempFile.Name())
err = fileutil.SecureFiles(tempFile.Name())
if err != nil {
t.Fatalf("Could not secure temporary file: %v", err)
}
expires := tcclient.Time(time.Now().Add(time.Minute * 30))
command := helloGoodbye()
payload := GenericWorkerPayload{
Command: command,
MaxRunTime: 30,
Artifacts: []Artifact{
{
Path: filepath.Join("../../../", filepath.Base(tempFile.Name())),
Expires: expires,
Type: "file",
Name: fmt.Sprintf("public/build/%s.txt", t.Name()),
},
},
}
defaults.SetDefaults(&payload)
td := testTask(t)
if config.RunTasksAsCurrentUser {
_ = submitAndAssert(t, td, payload, "completed", "completed")
} else {
_ = submitAndAssert(t, td, payload, "failed", "failed")
}
}