-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathrepository.go
More file actions
435 lines (373 loc) · 12.6 KB
/
repository.go
File metadata and controls
435 lines (373 loc) · 12.6 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
package connector
import (
"context"
"fmt"
"net/http"
"strconv"
"strings"
v2 "github.com/conductorone/baton-sdk/pb/c1/connector/v2"
"github.com/conductorone/baton-sdk/pkg/annotations"
"github.com/conductorone/baton-sdk/pkg/pagination"
"github.com/conductorone/baton-sdk/pkg/types/entitlement"
"github.com/conductorone/baton-sdk/pkg/types/grant"
"github.com/conductorone/baton-sdk/pkg/types/resource"
"github.com/conductorone/baton-sdk/pkg/uhttp"
"github.com/google/go-github/v69/github"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
"go.uber.org/zap"
"google.golang.org/grpc/codes"
)
// outside collaborators are given one of these roles too.
const (
repoPermissionPull = "pull"
repoPermissionTriage = "triage"
repoPermissionPush = "push"
repoPermissionMaintain = "maintain"
repoPermissionAdmin = "admin"
)
var repoAccessLevels = []string{
repoPermissionPull,
repoPermissionTriage,
repoPermissionPush,
repoPermissionMaintain,
repoPermissionAdmin,
}
// repositoryResource returns a new connector resource for a GitHub repository.
func repositoryResource(ctx context.Context, repo *github.Repository, parentResourceID *v2.ResourceId) (*v2.Resource, error) {
ret, err := resource.NewResource(
repo.GetName(),
resourceTypeRepository,
repo.GetID(),
resource.WithAnnotation(
&v2.ExternalLink{Url: repo.GetHTMLURL()},
&v2.V1Identifier{Id: fmt.Sprintf("repo:%d", repo.GetID())},
),
resource.WithParentResourceID(parentResourceID),
)
if err != nil {
return nil, err
}
return ret, nil
}
type repositoryResourceType struct {
resourceType *v2.ResourceType
client *github.Client
orgCache *orgNameCache
omitArchivedRepositories bool
}
func (o *repositoryResourceType) ResourceType(_ context.Context) *v2.ResourceType {
return o.resourceType
}
func (o *repositoryResourceType) List(ctx context.Context, parentID *v2.ResourceId, pt *pagination.Token) ([]*v2.Resource, string, annotations.Annotations, error) {
if parentID == nil {
return nil, "", nil, nil
}
bag, page, err := parsePageToken(pt.Token, &v2.ResourceId{ResourceType: resourceTypeRepository.Id})
if err != nil {
return nil, "", nil, err
}
orgName, err := o.orgCache.GetOrgName(ctx, parentID)
if err != nil {
return nil, "", nil, err
}
opts := &github.RepositoryListByOrgOptions{
ListOptions: github.ListOptions{
Page: page,
PerPage: maxPageSize,
},
}
repos, resp, err := o.client.Repositories.ListByOrg(ctx, orgName, opts)
if err != nil {
return nil, "", nil, wrapGitHubError(err, resp, "github-connector: failed to list repositories")
}
nextPage, reqAnnos, err := parseResp(resp)
if err != nil {
return nil, "", nil, err
}
pageToken, err := bag.NextToken(nextPage)
if err != nil {
return nil, "", nil, err
}
rv := make([]*v2.Resource, 0, len(repos))
for _, repo := range repos {
if o.omitArchivedRepositories && repo.GetArchived() {
continue
}
rr, err := repositoryResource(ctx, repo, parentID)
if err != nil {
return nil, "", nil, err
}
rv = append(rv, rr)
}
return rv, pageToken, reqAnnos, nil
}
func (o *repositoryResourceType) Entitlements(_ context.Context, resource *v2.Resource, _ *pagination.Token) ([]*v2.Entitlement, string, annotations.Annotations, error) {
rv := make([]*v2.Entitlement, 0, len(repoAccessLevels))
for _, level := range repoAccessLevels {
rv = append(rv, entitlement.NewPermissionEntitlement(resource, level,
entitlement.WithDisplayName(fmt.Sprintf("%s Repo %s", resource.DisplayName, titleCase(level))),
entitlement.WithDescription(fmt.Sprintf("Access to %s repository in GitHub", resource.DisplayName)),
entitlement.WithAnnotation(&v2.V1Identifier{
Id: fmt.Sprintf("repo:%s:role:%s", resource.Id.Resource, level),
}),
entitlement.WithGrantableTo(resourceTypeUser, resourceTypeTeam),
))
}
return rv, "", nil, nil
}
func (o *repositoryResourceType) Grants(
ctx context.Context,
resource *v2.Resource,
pToken *pagination.Token,
) ([]*v2.Grant, string, annotations.Annotations, error) {
l := ctxzap.Extract(ctx)
bag, page, err := parsePageToken(pToken.Token, resource.Id)
if err != nil {
return nil, "", nil, err
}
orgName, err := o.orgCache.GetOrgName(ctx, resource.ParentResourceId)
if err != nil {
return nil, "", nil, err
}
var rv []*v2.Grant
var reqAnnos annotations.Annotations
switch bag.ResourceTypeID() {
case resourceTypeRepository.Id:
bag.Pop()
bag.Push(pagination.PageState{
ResourceTypeID: resourceTypeUser.Id,
})
bag.Push(pagination.PageState{
ResourceTypeID: resourceTypeTeam.Id,
})
case resourceTypeUser.Id:
opts := &github.ListCollaboratorsOptions{
Affiliation: "all",
ListOptions: github.ListOptions{
Page: page,
PerPage: maxPageSize,
},
}
users, resp, err := o.client.Repositories.ListCollaborators(ctx, orgName, resource.DisplayName, opts)
if err != nil {
if resp != nil && resp.StatusCode == http.StatusForbidden {
l.Warn("insufficient access to list collaborators", zap.String("repository", resource.DisplayName))
pageToken, err := skipGrantsForResourceType(bag)
if err != nil {
return nil, "", nil, err
}
return nil, pageToken, nil, nil
}
if isNotFoundError(resp) {
return nil, "", nil, uhttp.WrapErrors(codes.NotFound, fmt.Sprintf("repo: %s not found", resource.DisplayName))
}
return nil, "", nil, wrapGitHubError(err, resp, "github-connector: failed to list collaborators")
}
nextPage, respAnnos, err := parseResp(resp)
if err != nil {
return nil, "", nil, err
}
reqAnnos = respAnnos
err = bag.Next(nextPage)
if err != nil {
return nil, "", nil, err
}
for _, user := range users {
for permission, hasPermission := range user.Permissions {
if !hasPermission {
continue
}
ur, err := userResource(ctx, user, user.GetEmail(), nil)
if err != nil {
return nil, "", nil, err
}
grant := grant.NewGrant(resource, permission, ur.Id, grant.WithAnnotation(&v2.V1Identifier{
Id: fmt.Sprintf("repo-grant:%s:%d:%s", resource.Id.Resource, user.GetID(), permission),
}))
grant.Principal = ur
rv = append(rv, grant)
}
}
case resourceTypeTeam.Id:
opts := &github.ListOptions{
Page: page,
PerPage: maxPageSize,
}
teams, resp, err := o.client.Repositories.ListTeams(ctx, orgName, resource.DisplayName, opts)
if err != nil {
if resp != nil && resp.StatusCode == http.StatusForbidden {
l.Warn("insufficient access to list teams", zap.String("repository", resource.DisplayName))
pageToken, err := skipGrantsForResourceType(bag)
if err != nil {
return nil, "", nil, err
}
return nil, pageToken, nil, nil
}
if isNotFoundError(resp) {
return nil, "", nil, uhttp.WrapErrors(codes.NotFound, fmt.Sprintf("repo: %s not found", resource.DisplayName))
}
return nil, "", nil, wrapGitHubError(err, resp, "github-connector: failed to list repository teams")
}
nextPage, respAnnos, err := parseResp(resp)
if err != nil {
return nil, "", nil, err
}
reqAnnos = respAnnos
err = bag.Next(nextPage)
if err != nil {
return nil, "", nil, err
}
for _, team := range teams {
for permission, hasPermission := range team.Permissions {
if !hasPermission {
continue
}
tr, err := teamResource(team, resource.ParentResourceId)
if err != nil {
return nil, "", nil, err
}
rv = append(rv, grant.NewGrant(resource, permission, tr.Id, grant.WithAnnotation(
&v2.V1Identifier{
Id: fmt.Sprintf("repo-grant:%s:%d:%s", resource.Id.Resource, team.GetID(), permission),
},
&v2.GrantExpandable{
EntitlementIds: []string{
entitlement.NewEntitlementID(tr, teamRoleMaintainer),
entitlement.NewEntitlementID(tr, teamRoleMember),
},
Shallow: true,
},
)))
}
}
default:
return nil, "", nil, fmt.Errorf("unexpected resource type while fetching grants for repo")
}
pageToken, err := bag.Marshal()
if err != nil {
return nil, "", nil, err
}
return rv, pageToken, reqAnnos, nil
}
func (o *repositoryResourceType) Grant(ctx context.Context, principal *v2.Resource, en *v2.Entitlement) (annotations.Annotations, error) {
l := ctxzap.Extract(ctx)
repoID, err := strconv.ParseInt(en.Resource.Id.Resource, 10, 64)
if err != nil {
return nil, err
}
repo, resp, err := o.client.Repositories.GetByID(ctx, repoID)
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to get repository")
}
org := repo.GetOrganization()
principalID, err := strconv.ParseInt(principal.Id.Resource, 10, 64)
if err != nil {
return nil, err
}
enIDParts := strings.Split(en.Id, ":")
if len(enIDParts) != 3 {
return nil, fmt.Errorf("github-connectorv2: invalid entitlement ID: %s", en.Id)
}
permission := enIDParts[2]
switch principal.Id.ResourceType {
case resourceTypeUser.Id:
user, resp, err := o.client.Users.GetByID(ctx, principalID)
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to get user")
}
_, resp, er := o.client.Repositories.AddCollaborator(
ctx,
repo.GetOwner().GetLogin(),
repo.GetName(),
user.GetLogin(),
&github.RepositoryAddCollaboratorOptions{Permission: permission},
)
if er != nil {
return nil, wrapGitHubError(er, resp, "github-connector: failed to add user to repository")
}
case resourceTypeTeam.Id:
team, resp, err := o.client.Teams.GetTeamByID(ctx, org.GetID(), principalID) //nolint:staticcheck // TODO: migrate to GetTeamBySlug
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to get team")
}
resp, err = o.client.Teams.AddTeamRepoBySlug(ctx, org.GetLogin(), team.GetSlug(), repo.GetOwner().GetLogin(), repo.GetName(), &github.TeamAddTeamRepoOptions{
Permission: permission,
})
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to add team to repository")
}
default:
l.Error(
"github-connectorv2: only users and teams can be granted repository membership",
zap.String("principal_type", principal.Id.ResourceType),
zap.String("principal_id", principal.Id.Resource),
)
return nil, fmt.Errorf("github-connectorv2: only users and teams can be granted team membership")
}
return nil, nil
}
func (o *repositoryResourceType) Revoke(ctx context.Context, grant *v2.Grant) (annotations.Annotations, error) {
l := ctxzap.Extract(ctx)
en := grant.Entitlement
principal := grant.Principal
repoID, err := strconv.ParseInt(en.Resource.Id.Resource, 10, 64)
if err != nil {
return nil, err
}
repo, resp, err := o.client.Repositories.GetByID(ctx, repoID)
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to get repository")
}
org := repo.GetOrganization()
principalID, err := strconv.ParseInt(principal.Id.Resource, 10, 64)
if err != nil {
return nil, err
}
switch principal.Id.ResourceType {
case resourceTypeUser.Id:
user, resp, err := o.client.Users.GetByID(ctx, principalID)
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to get user")
}
resp, er := o.client.Repositories.RemoveCollaborator(ctx, repo.GetOwner().GetLogin(), repo.GetName(), user.GetLogin())
if er != nil {
return nil, wrapGitHubError(er, resp, "github-connector: failed to remove user from repository")
}
case resourceTypeTeam.Id:
team, resp, err := o.client.Teams.GetTeamByID(ctx, org.GetID(), principalID) //nolint:staticcheck // TODO: migrate to GetTeamBySlug
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to get team")
}
resp, err = o.client.Teams.RemoveTeamRepoBySlug(ctx, org.GetLogin(), team.GetSlug(), repo.GetOwner().GetLogin(), repo.GetName())
if err != nil {
return nil, wrapGitHubError(err, resp, "github-connector: failed to remove team from repository")
}
default:
l.Error(
"github-connectorv2: only users and teams can have repository membership revoked",
zap.String("principal_type", principal.Id.ResourceType),
zap.String("principal_id", principal.Id.Resource),
)
return nil, fmt.Errorf("github-connectorv2: only users and teams can be granted team membership")
}
return nil, nil
}
func repositoryBuilder(client *github.Client, orgCache *orgNameCache, omitArchivedRepositories bool) *repositoryResourceType {
return &repositoryResourceType{
resourceType: resourceTypeRepository,
client: client,
orgCache: orgCache,
omitArchivedRepositories: omitArchivedRepositories,
}
}
func skipGrantsForResourceType(bag *pagination.Bag) (string, error) {
err := bag.Next("")
if err != nil {
return "", err
}
pageToken, err := bag.Marshal()
if err != nil {
return "", err
}
return pageToken, nil
}