-
Notifications
You must be signed in to change notification settings - Fork 50
/
project.go
534 lines (450 loc) · 14.7 KB
/
project.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
package project
import (
"context"
"errors"
uc "github.com/mittwald/goharbor-client/v5/apiv1/user"
"github.com/mittwald/goharbor-client/v5/apiv1/internal/api/client"
"github.com/go-openapi/runtime"
"github.com/mittwald/goharbor-client/v5/apiv1/internal/api/client/products"
"github.com/mittwald/goharbor-client/v5/apiv1/model"
)
const (
ProjectMetadataKeyEnableContentTrust MetadataKey = "enable_content_trust"
ProjectMetadataKeyAutoScan MetadataKey = "auto_scan"
ProjectMetadataKeySeverity MetadataKey = "severity"
ProjectMetadataKeyReuseSysCVEWhitelist MetadataKey = "reuse_sys_cve_whitelist"
ProjectMetadataKeyPublic MetadataKey = "public"
ProjectMetadataKeyPreventVul MetadataKey = "prevent_vul"
)
// RESTClient is a subclient forhandling project related actions.
type RESTClient struct {
// The swagger client
Client *client.Harbor
// AuthInfo contain auth information, which are provided on API calls.
AuthInfo runtime.ClientAuthInfoWriter
}
func NewClient(cl *client.Harbor, authInfo runtime.ClientAuthInfoWriter) *RESTClient {
return &RESTClient{
Client: cl,
AuthInfo: authInfo,
}
}
type MetadataKey string
type Client interface {
NewProject(ctx context.Context, name string, countLimit int, storageLimit int)
DeleteProject(ctx context.Context, p *model.Project) error
GetProject(ctx context.Context, name string) (*model.Project, error)
ListProjects(ctx context.Context, nameFilter string) ([]*model.Project, error)
UpdateProject(ctx context.Context, p *model.Project, countLimit int, storageLimit int) error
AddProjectMember(ctx context.Context, p *model.Project, u *model.User, roleID int) error
ListProjectMembers(ctx context.Context, p *model.Project) ([]*model.ProjectMemberEntity, error)
UpdateProjectMemberRole(ctx context.Context, p *model.Project, u *model.User, roleID int) error
DeleteProjectMember(ctx context.Context, p *model.Project, u *model.User) error
AddProjectMetadata(ctx context.Context, p *model.Project, key MetadataKey, value string) error
ListProjectMetadata(ctx context.Context, p *model.Project) (*model.ProjectMetadata, error)
GetProjectMetadataValue(ctx context.Context, p *model.Project, key MetadataKey) (string, error)
UpdateProjectMetadata(ctx context.Context, p *model.Project, key MetadataKey, value string) error
DeleteProjectMetadataValue(ctx context.Context, p *model.Project, key MetadataKey) error
}
// NewProject creates a new project with name as the project's name.
// Returns the project as it is stored inside Harbor or an error,
// if the project could not be created.
// CountLimit limits the number of repositories for this project.
// StorageLimit limits the allocatable space for this project.
func (c *RESTClient) NewProject(ctx context.Context, name string,
countLimit int, storageLimit int,
) (*model.Project, error) {
pReq := &model.ProjectReq{
CveWhitelist: nil,
Metadata: nil,
ProjectName: name,
CountLimit: int64(countLimit),
StorageLimit: int64(storageLimit) * 1024 * 1024,
}
_, err := c.Client.Products.PostProjects(
&products.PostProjectsParams{
Project: pReq,
Context: ctx,
}, c.AuthInfo)
if err != nil {
return nil, handleSwaggerProjectErrors(err)
}
project, err := c.GetProject(ctx, name)
if err != nil {
return nil, err
}
return project, nil
}
// DeleteProject deletes the specified project.
// Returns an error when no matching project is found or when
// having difficulties talking to the API.
func (c *RESTClient) DeleteProject(ctx context.Context,
p *model.Project,
) error {
if p == nil {
return &ErrProjectNotProvided{}
}
projectExists, err := c.projectExists(ctx, p)
if err != nil {
return err
}
if !projectExists {
return &ErrProjectMismatch{}
}
_, err = c.Client.Products.DeleteProjectsProjectID(
&products.DeleteProjectsProjectIDParams{
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// GetProject returns an existing project identified by name.
// Returns an error if it cannot find a matching project or when
// having difficulties talking to the API.
func (c *RESTClient) GetProject(ctx context.Context,
name string,
) (*model.Project, error) {
if name == "" {
return nil, &ErrProjectNameNotProvided{}
}
resp, err := c.Client.Products.GetProjects(
&products.GetProjectsParams{
Name: &name,
Context: ctx,
}, c.AuthInfo)
if err != nil {
return nil, handleSwaggerProjectErrors(err)
}
for _, p := range resp.Payload {
if p.Name == name {
return p, nil
}
}
return nil, &ErrProjectNotFound{}
}
// ListProjects returns a list of projects based on a name filter.
// Returns all projects if name is an empty string.
// Returns an error if no projects were found.
func (c *RESTClient) ListProjects(ctx context.Context,
nameFilter string,
) ([]*model.Project, error) {
resp, err := c.Client.Products.GetProjects(
&products.GetProjectsParams{
Name: &nameFilter,
Context: ctx,
}, c.AuthInfo)
if err != nil {
return nil, handleSwaggerProjectErrors(err)
}
if len(resp.Payload) == 0 {
return nil, &ErrProjectNotFound{}
}
return resp.Payload, nil
}
// UpdateProject updates a project with the specified data.
// Returns an error if name/ID pair of p does not match a stored project.
func (c *RESTClient) UpdateProject(ctx context.Context, p *model.Project,
countLimit int, storageLimit int,
) error {
project, err := c.GetProject(ctx, p.Name)
if err != nil {
return err
}
if p.ProjectID != project.ProjectID {
return &ErrProjectMismatch{}
}
pReq := &model.ProjectReq{
CveWhitelist: p.CveWhitelist,
Metadata: p.Metadata,
ProjectName: p.Name,
CountLimit: int64(countLimit),
StorageLimit: int64(storageLimit) * 1024 * 1024,
}
_, err = c.Client.Products.PutProjectsProjectID(
&products.PutProjectsProjectIDParams{
Project: pReq,
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// AddProjectMember creates a membership between a user and a project.
func (c *RESTClient) AddProjectMember(ctx context.Context, p *model.Project, u *model.User, roleID int) error {
if p == nil {
return &ErrProjectNotProvided{}
}
if u == nil {
return &ErrProjectNoMemberProvided{}
}
projectExists, err := c.projectExists(ctx, p)
if err != nil {
return err
}
if !projectExists {
return &ErrProjectMismatch{}
}
userClient := uc.NewClient(c.Client, c.AuthInfo)
userExists, err := userClient.UserExists(ctx, u)
if err != nil {
return err
}
if !userExists {
return &ErrProjectMemberMismatch{}
}
m := &model.ProjectMember{
RoleID: int64(roleID),
MemberUser: &model.UserEntity{
UserID: u.UserID,
Username: u.Username,
},
MemberGroup: &model.UserGroup{},
}
_, err = c.Client.Products.PostProjectsProjectIDMembers(
&products.PostProjectsProjectIDMembersParams{
ProjectID: int64(p.ProjectID),
ProjectMember: m,
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// ListProjectMembers returns a list of project members.
func (c *RESTClient) ListProjectMembers(ctx context.Context, p *model.Project) ([]*model.ProjectMemberEntity, error) {
if p == nil {
return nil, &ErrProjectNotProvided{}
}
entityName := ""
resp, err := c.Client.Products.GetProjectsProjectIDMembers(
&products.GetProjectsProjectIDMembersParams{
Entityname: &entityName,
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
if err != nil {
return nil, handleSwaggerProjectErrors(err)
}
return resp.Payload, nil
}
// UpdateProjectMemberRole updates the role of a project member.
func (c *RESTClient) UpdateProjectMemberRole(ctx context.Context, p *model.Project, u *model.User, roleID int) error {
if p == nil {
return &ErrProjectNotProvided{}
}
if u == nil {
return &ErrProjectNoMemberProvided{}
}
projectExists, err := c.projectExists(ctx, p)
if err != nil {
return err
}
if !projectExists {
return &ErrProjectMismatch{}
}
mid, err := c.getMid(ctx, p, u)
if err != nil {
return err
}
roleRequest := &model.RoleRequest{RoleID: int64(roleID)}
_, err = c.Client.Products.PutProjectsProjectIDMembersMid(
&products.PutProjectsProjectIDMembersMidParams{
Mid: mid,
ProjectID: int64(p.ProjectID),
Role: roleRequest,
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// DeleteProjectMember deletes the membership between a user and a project.
func (c *RESTClient) DeleteProjectMember(ctx context.Context, p *model.Project, u *model.User) error {
if p == nil {
return &ErrProjectNotProvided{}
}
if u == nil {
return &ErrProjectNoMemberProvided{}
}
projectExists, err := c.projectExists(ctx, p)
if err != nil {
return err
}
if !projectExists {
return &ErrProjectMismatch{}
}
mid, err := c.getMid(ctx, p, u)
if err != nil {
return err
}
_, err = c.Client.Products.DeleteProjectsProjectIDMembersMid(
&products.DeleteProjectsProjectIDMembersMidParams{
Mid: mid,
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// getProjectMetadataByKey returns a ProjectMetadata object matching
// the provided key and containing the provided value.
func getProjectMetadataByKey(key MetadataKey, value string) *model.ProjectMetadata {
var m model.ProjectMetadata
switch key {
case ProjectMetadataKeyEnableContentTrust:
m.EnableContentTrust = value
case ProjectMetadataKeyAutoScan:
m.AutoScan = value
case ProjectMetadataKeySeverity:
m.Severity = value
case ProjectMetadataKeyReuseSysCVEWhitelist:
m.ReuseSysCveWhitelist = value
case ProjectMetadataKeyPublic:
m.Public = value
case ProjectMetadataKeyPreventVul:
m.PreventVul = value
}
return &m
}
// AddMetadata adds metadata with a specific key and value to project p.
// See this for more explanation of possible keys and values:
// https://github.com/goharbor/harbor/blob/v1.10.2/api/harbor/swagger.yaml#L4894
func (c *RESTClient) AddProjectMetadata(ctx context.Context, p *model.Project, key MetadataKey, value string) error {
if p == nil {
return &ErrProjectNotProvided{}
}
_, err := c.Client.Products.PostProjectsProjectIDMetadatas(
&products.PostProjectsProjectIDMetadatasParams{
Metadata: getProjectMetadataByKey(key, value),
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
err = handleSwaggerProjectErrors(err)
if err != nil {
t, ok := err.(*runtime.APIError)
if ok && t.Code == 409 {
// Unspecified error that returns when a metadata key is already defined.
return &ErrProjectMetadataAlreadyExists{}
}
return err
}
return handleSwaggerProjectErrors(err)
}
// GetProjectMetadataValue retrieves metadata with key of project p.
func (c *RESTClient) GetProjectMetadataValue(ctx context.Context, p *model.Project, key MetadataKey) (string, error) {
if p == nil {
return "", &ErrProjectNotProvided{}
}
resp, err := c.Client.Products.GetProjectsProjectIDMetadatasMetaName(
&products.GetProjectsProjectIDMetadatasMetaNameParams{
MetaName: string(key),
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
if err != nil {
return "", handleSwaggerProjectErrors(err)
}
var result string
switch key {
case ProjectMetadataKeyEnableContentTrust:
result = resp.Payload.EnableContentTrust
case ProjectMetadataKeyAutoScan:
result = resp.Payload.AutoScan
case ProjectMetadataKeySeverity:
result = resp.Payload.Severity
case ProjectMetadataKeyReuseSysCVEWhitelist:
result = resp.Payload.ReuseSysCveWhitelist
case ProjectMetadataKeyPublic:
result = resp.Payload.Public
case ProjectMetadataKeyPreventVul:
result = resp.Payload.PreventVul
default:
return "", &ErrProjectInvalidRequest{}
}
return result, nil
}
// ListMetadata lists all metadata of a project
func (c *RESTClient) ListProjectMetadata(ctx context.Context, p *model.Project) (*model.ProjectMetadata, error) {
if p == nil {
return nil, &ErrProjectNotProvided{}
}
resp, err := c.Client.Products.GetProjectsProjectIDMetadatas(
&products.GetProjectsProjectIDMetadatasParams{
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
if err != nil {
return nil, handleSwaggerProjectErrors(err)
}
return resp.Payload, nil
}
// UpdateMetadata deletes the specified metadata key, if it exists and re-adds this metadata key with the given value.
// This function works around the faulty behaviour of the corresponding 'Update' endpoint of the Harbor API.
func (c *RESTClient) UpdateProjectMetadata(ctx context.Context, p *model.Project, key MetadataKey, value string) error {
if p == nil {
return &ErrProjectNotProvided{}
}
pID := int64(p.ProjectID)
metaKeyName := string(key)
_, err := c.Client.Products.GetProjectsProjectIDMetadatasMetaName(
&products.GetProjectsProjectIDMetadatasMetaNameParams{
MetaName: metaKeyName,
ProjectID: pID,
Context: ctx,
}, c.AuthInfo)
if err != nil {
return handleSwaggerProjectErrors(err)
}
_, err = c.Client.Products.DeleteProjectsProjectIDMetadatasMetaName(
&products.DeleteProjectsProjectIDMetadatasMetaNameParams{
MetaName: metaKeyName,
ProjectID: pID,
Context: ctx,
}, c.AuthInfo)
if err != nil {
return handleSwaggerProjectErrors(err)
}
_, err = c.Client.Products.PostProjectsProjectIDMetadatas(
&products.PostProjectsProjectIDMetadatasParams{
Metadata: getProjectMetadataByKey(key, value),
ProjectID: pID,
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// DeleteMetadataValue deletes metadata of project p given by key.
func (c *RESTClient) DeleteProjectMetadataValue(ctx context.Context, p *model.Project, key MetadataKey) error {
if p == nil {
return &ErrProjectNotProvided{}
}
_, err := c.Client.Products.DeleteProjectsProjectIDMetadatasMetaName(
&products.DeleteProjectsProjectIDMetadatasMetaNameParams{
MetaName: string(key),
ProjectID: int64(p.ProjectID),
Context: ctx,
}, c.AuthInfo)
return handleSwaggerProjectErrors(err)
}
// projectExists returns true, if p matches a project on server side.
// Returns false, if not found.
// Returns an error in case of communication problems.
func (c *RESTClient) projectExists(ctx context.Context, p *model.Project) (bool, error) {
_, err := c.GetProject(ctx, p.Name)
if err != nil {
if errors.Is(err, &ErrProjectNotFound{}) {
return false, nil
} else {
return false, err
}
}
return true, nil
}
// getMid returns the member ID of a user u in project p.
// Returns an error, if user is not a member in project or
// in case a communication error has occurred.
func (c *RESTClient) getMid(ctx context.Context, p *model.Project, u *model.User) (int64, error) {
members, err := c.ListProjectMembers(ctx, p)
if err != nil {
return 0, err
}
for _, v := range members {
if v.EntityType == "u" && v.EntityName == u.Username {
return v.ID, nil
}
}
return 0, &ErrProjectUserIsNoMember{}
}