-
Notifications
You must be signed in to change notification settings - Fork 28
/
perm.go
546 lines (436 loc) · 15.7 KB
/
perm.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
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
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
// SPDX-License-Identifier: Apache-2.0
package perm
import (
"fmt"
"net/http"
"strings"
"github.com/gin-gonic/gin"
"github.com/go-vela/server/database"
"github.com/go-vela/server/router/middleware/build"
"github.com/go-vela/server/router/middleware/claims"
"github.com/go-vela/server/router/middleware/org"
"github.com/go-vela/server/router/middleware/repo"
"github.com/go-vela/server/router/middleware/user"
"github.com/go-vela/server/scm"
"github.com/go-vela/server/util"
"github.com/go-vela/types/constants"
"github.com/sirupsen/logrus"
)
// MustPlatformAdmin ensures the user has admin access to the platform.
func MustPlatformAdmin() gin.HandlerFunc {
return func(c *gin.Context) {
cl := claims.Retrieve(c)
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logrus.WithFields(logrus.Fields{
"user": cl.Subject,
}).Debugf("verifying user %s is a platform admin", cl.Subject)
switch {
case cl.IsAdmin:
return
default:
if strings.EqualFold(cl.TokenType, constants.WorkerBuildTokenType) {
logrus.WithFields(logrus.Fields{
"user": cl.Subject,
"repo": cl.Repo,
"build": cl.BuildID,
}).Warnf("attempted access of admin endpoint with build token from %s", cl.Subject)
}
retErr := fmt.Errorf("user %s is not a platform admin", cl.Subject)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}
// MustWorkerRegisterToken ensures the token is a registration token retrieved by a platform admin.
func MustWorkerRegisterToken() gin.HandlerFunc {
return func(c *gin.Context) {
cl := claims.Retrieve(c)
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logrus.WithFields(logrus.Fields{
"user": cl.Subject,
}).Debugf("verifying user %s has a registration token for worker", cl.Subject)
switch cl.TokenType {
case constants.WorkerRegisterTokenType:
return
case constants.ServerWorkerTokenType:
if strings.EqualFold(cl.Subject, "vela-worker") {
return
}
retErr := fmt.Errorf("server-worker token provided but does not match configuration")
util.HandleError(c, http.StatusBadRequest, retErr)
return
default:
retErr := fmt.Errorf("invalid token type: must provide a worker registration token")
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}
// MustWorkerAuthToken ensures the token is a worker auth token.
func MustWorkerAuthToken() gin.HandlerFunc {
return func(c *gin.Context) {
cl := claims.Retrieve(c)
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logrus.WithFields(logrus.Fields{
"worker": cl.Subject,
}).Debugf("verifying worker %s has a valid auth token", cl.Subject)
// global permissions bypass
if cl.IsAdmin {
logrus.WithFields(logrus.Fields{
"user": cl.Subject,
}).Debugf("user %s has platform admin permissions", cl.Subject)
return
}
switch cl.TokenType {
case constants.WorkerAuthTokenType, constants.WorkerRegisterTokenType:
return
case constants.ServerWorkerTokenType:
if strings.EqualFold(cl.Subject, "vela-worker") {
return
}
retErr := fmt.Errorf("server-worker token provided but does not match configuration")
util.HandleError(c, http.StatusBadRequest, retErr)
return
default:
retErr := fmt.Errorf("invalid token type: must provide a worker auth token")
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}
// MustBuildAccess ensures the token is a build token for the appropriate build.
func MustBuildAccess() gin.HandlerFunc {
return func(c *gin.Context) {
cl := claims.Retrieve(c)
b := build.Retrieve(c)
// global permissions bypass
if cl.IsAdmin {
logrus.WithFields(logrus.Fields{
"user": cl.Subject,
}).Debugf("user %s has platform admin permissions", cl.Subject)
return
}
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logrus.WithFields(logrus.Fields{
"worker": cl.Subject,
}).Debugf("verifying worker %s has a valid build token", cl.Subject)
// validate token type and match build id in request with build id in token claims
switch cl.TokenType {
case constants.WorkerBuildTokenType:
if b.GetID() == cl.BuildID {
return
}
logrus.WithFields(logrus.Fields{
"user": cl.Subject,
"repo": cl.Repo,
"build": cl.BuildID,
}).Warnf("build token for build %d attempted to be used for build %d by %s", cl.BuildID, b.GetID(), cl.Subject)
fallthrough
default:
retErr := fmt.Errorf("invalid token: must provide matching worker build token")
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}
// MustSecretAdmin ensures the user has admin access to the org, repo or team.
//
//nolint:funlen // ignore function length
func MustSecretAdmin() gin.HandlerFunc {
return func(c *gin.Context) {
cl := claims.Retrieve(c)
u := user.Retrieve(c)
e := util.PathParameter(c, "engine")
t := util.PathParameter(c, "type")
o := util.PathParameter(c, "org")
n := util.PathParameter(c, "name")
s := util.PathParameter(c, "secret")
m := c.Request.Method
ctx := c.Request.Context()
// create log fields from API metadata
fields := logrus.Fields{
"engine": e,
"org": o,
"repo": n,
"type": t,
"user": u.GetName(),
}
// check if secret is a shared secret
if strings.EqualFold(t, constants.SecretShared) {
// update log fields from API metadata
fields = logrus.Fields{
"engine": e,
"org": o,
"team": n,
"type": t,
"user": u.GetName(),
}
}
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logger := logrus.WithFields(fields)
if u.GetAdmin() {
return
}
// if caller is worker with build token, verify it has access to requested secret
if strings.EqualFold(cl.TokenType, constants.WorkerBuildTokenType) {
org, repo := util.SplitFullName(cl.Repo)
switch t {
case constants.SecretShared:
return
case constants.SecretOrg:
logger.Debugf("verifying subject %s has token permissions for org %s", cl.Subject, o)
if strings.EqualFold(org, o) {
return
}
logger.Warnf("build token for build %s/%d attempted to be used for secret %s/%s by %s", cl.Repo, cl.BuildID, o, s, cl.Subject)
retErr := fmt.Errorf("subject %s does not have token permissions for the org %s", cl.Subject, o)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
case constants.SecretRepo:
logger.Debugf("verifying subject %s has token permissions for repo %s/%s", cl.Subject, o, n)
if strings.EqualFold(org, o) && strings.EqualFold(repo, n) {
return
}
logger.Warnf("build token for build %s/%d attempted to be used for secret %s/%s/%s by %s", cl.Repo, cl.BuildID, o, n, s, cl.Subject)
retErr := fmt.Errorf("subject %s does not have token permissions for the repo %s/%s", cl.Subject, o, n)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
switch t {
case constants.SecretOrg:
logger.Debugf("verifying user %s has 'admin' permissions for org %s", u.GetName(), o)
perm, err := scm.FromContext(c).OrgAccess(ctx, u, o)
if err != nil {
logger.Errorf("unable to get user %s access level for org %s: %v", u.GetName(), o, err)
}
if !strings.EqualFold(perm, "admin") {
retErr := fmt.Errorf("user %s does not have 'admin' permissions for the org %s", u.GetName(), o)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
case constants.SecretRepo:
logger.Debugf("verifying user %s has 'admin' permissions for repo %s/%s", u.GetName(), o, n)
perm, err := scm.FromContext(c).RepoAccess(ctx, u.GetName(), u.GetToken(), o, n)
if err != nil {
logger.Errorf("unable to get user %s access level for repo %s/%s: %v", u.GetName(), o, n, err)
}
if !strings.EqualFold(perm, "admin") {
retErr := fmt.Errorf("user %s does not have 'admin' permissions for the repo %s/%s", u.GetName(), o, n)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
case constants.SecretShared:
if n == "*" && m == "GET" {
// check if user is accessing shared secrets in personal org
if strings.EqualFold(o, u.GetName()) {
logger.WithFields(logrus.Fields{
"org": o,
"user": u.GetName(),
}).Debugf("skipping gathering teams for user %s with org %s", u.GetName(), o)
return
}
logger.Debugf("gathering teams user %s is a member of in the org %s", u.GetName(), o)
teams, err := scm.FromContext(c).ListUsersTeamsForOrg(ctx, u, o)
if err != nil {
logger.Errorf("unable to get users %s teams for org %s: %v", u.GetName(), o, err)
}
if len(teams) == 0 {
retErr := fmt.Errorf("user %s is not a member of any team for the org %s", u.GetName(), o)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
} else {
logger.Debugf("verifying user %s has 'admin' permissions for team %s/%s", u.GetName(), o, n)
perm, err := scm.FromContext(c).TeamAccess(ctx, u, o, n)
if err != nil {
logger.Errorf("unable to get user %s access level for team %s/%s: %v", u.GetName(), o, n, err)
}
if !strings.EqualFold(perm, "admin") {
retErr := fmt.Errorf("user %s does not have 'admin' permissions for the team %s/%s", u.GetName(), o, n)
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
default:
retErr := fmt.Errorf("invalid secret type: %v", t)
util.HandleError(c, http.StatusBadRequest, retErr)
return
}
}
}
// MustAdmin ensures the user has admin access to the repo.
func MustAdmin() gin.HandlerFunc {
return func(c *gin.Context) {
o := org.Retrieve(c)
r := repo.Retrieve(c)
u := user.Retrieve(c)
ctx := c.Request.Context()
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logger := logrus.WithFields(logrus.Fields{
"org": o,
"repo": r.GetName(),
"user": u.GetName(),
})
logger.Debugf("verifying user %s has 'admin' permissions for repo %s", u.GetName(), r.GetFullName())
if u.GetAdmin() {
return
}
// query source to determine requesters permissions for the repo using the requester's token
perm, err := scm.FromContext(c).RepoAccess(ctx, u.GetName(), u.GetToken(), r.GetOrg(), r.GetName())
if err != nil {
// requester may not have permissions to use the Github API endpoint (requires read access)
// try again using the repo owner token
//
// https://docs.github.com/en/rest/reference/repos#get-repository-permissions-for-a-user
ro, err := database.FromContext(c).GetUser(ctx, r.GetUserID())
if err != nil {
retErr := fmt.Errorf("unable to get owner for %s: %w", r.GetFullName(), err)
util.HandleError(c, http.StatusBadRequest, retErr)
return
}
perm, err = scm.FromContext(c).RepoAccess(ctx, u.GetName(), ro.GetToken(), r.GetOrg(), r.GetName())
if err != nil {
logger.Errorf("unable to get user %s access level for repo %s", u.GetName(), r.GetFullName())
}
}
switch perm {
//nolint:goconst // ignore making constant
case "admin":
return
default:
retErr := fmt.Errorf("user %s does not have 'admin' permissions for the repo %s", u.GetName(), r.GetFullName())
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}
// MustWrite ensures the user has admin or write access to the repo.
func MustWrite() gin.HandlerFunc {
return func(c *gin.Context) {
o := org.Retrieve(c)
r := repo.Retrieve(c)
u := user.Retrieve(c)
ctx := c.Request.Context()
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logger := logrus.WithFields(logrus.Fields{
"org": o,
"repo": r.GetName(),
"user": u.GetName(),
})
logger.Debugf("verifying user %s has 'write' permissions for repo %s", u.GetName(), r.GetFullName())
if u.GetAdmin() {
return
}
// query source to determine requesters permissions for the repo using the requester's token
perm, err := scm.FromContext(c).RepoAccess(ctx, u.GetName(), u.GetToken(), r.GetOrg(), r.GetName())
if err != nil {
// requester may not have permissions to use the Github API endpoint (requires read access)
// try again using the repo owner token
//
// https://docs.github.com/en/rest/reference/repos#get-repository-permissions-for-a-user
ro, err := database.FromContext(c).GetUser(ctx, r.GetUserID())
if err != nil {
retErr := fmt.Errorf("unable to get owner for %s: %w", r.GetFullName(), err)
util.HandleError(c, http.StatusBadRequest, retErr)
return
}
perm, err = scm.FromContext(c).RepoAccess(ctx, u.GetName(), ro.GetToken(), r.GetOrg(), r.GetName())
if err != nil {
logger.Errorf("unable to get user %s access level for repo %s", u.GetName(), r.GetFullName())
}
}
switch perm {
case "admin":
return
case "write":
return
default:
retErr := fmt.Errorf("user %s does not have 'write' permissions for the repo %s", u.GetName(), r.GetFullName())
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}
// MustRead ensures the user has admin, write or read access to the repo.
func MustRead() gin.HandlerFunc {
return func(c *gin.Context) {
cl := claims.Retrieve(c)
o := org.Retrieve(c)
r := repo.Retrieve(c)
u := user.Retrieve(c)
ctx := c.Request.Context()
// update engine logger with API metadata
//
// https://pkg.go.dev/github.com/sirupsen/logrus?tab=doc#Entry.WithFields
logger := logrus.WithFields(logrus.Fields{
"org": o,
"repo": r.GetName(),
"user": u.GetName(),
})
// check if the repo visibility field is set to public
if strings.EqualFold(r.GetVisibility(), constants.VisibilityPublic) {
logger.Debugf("skipping 'read' check for repo %s with %s visibility for user %s", r.GetFullName(), r.GetVisibility(), u.GetName())
return
}
// return if request is from worker with build token access
if strings.EqualFold(cl.TokenType, constants.WorkerBuildTokenType) {
b := build.Retrieve(c)
if cl.BuildID == b.GetID() {
return
}
retErr := fmt.Errorf("subject %s does not have 'read' permissions for repo %s", cl.Subject, r.GetFullName())
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
logger.Debugf("verifying user %s has 'read' permissions for repo %s", u.GetName(), r.GetFullName())
// return if user is platform admin
if u.GetAdmin() {
return
}
// query source to determine requesters permissions for the repo using the requester's token
perm, err := scm.FromContext(c).RepoAccess(ctx, u.GetName(), u.GetToken(), r.GetOrg(), r.GetName())
if err != nil {
// requester may not have permissions to use the Github API endpoint (requires read access)
// try again using the repo owner token
//
// https://docs.github.com/en/rest/reference/repos#get-repository-permissions-for-a-user
ro, err := database.FromContext(c).GetUser(ctx, r.GetUserID())
if err != nil {
retErr := fmt.Errorf("unable to get owner for %s: %w", r.GetFullName(), err)
util.HandleError(c, http.StatusBadRequest, retErr)
return
}
perm, err = scm.FromContext(c).RepoAccess(ctx, u.GetName(), ro.GetToken(), r.GetOrg(), r.GetName())
if err != nil {
logger.Errorf("unable to get user %s access level for repo %s", u.GetName(), r.GetFullName())
}
}
switch perm {
case "admin":
return
case "write":
return
case "read":
return
default:
retErr := fmt.Errorf("user %s does not have 'read' permissions for repo %s", u.GetName(), r.GetFullName())
util.HandleError(c, http.StatusUnauthorized, retErr)
return
}
}
}