-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
gitlab_client.go
428 lines (380 loc) · 13.6 KB
/
gitlab_client.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
package gitlab
import (
"context"
"errors"
"fmt"
"io"
"net/http"
"strings"
"time"
"github.com/hashicorp/go-hclog"
"github.com/hashicorp/vault/sdk/helper/logging"
g "github.com/xanzy/go-gitlab"
"golang.org/x/time/rate"
)
var (
ErrAccessTokenNotFound = errors.New("access token not found")
ErrRoleNotFound = errors.New("role not found")
)
type Client interface {
GitlabClient(ctx context.Context) *g.Client
Valid(ctx context.Context) bool
CurrentTokenInfo(ctx context.Context) (*EntryToken, error)
RotateCurrentToken(ctx context.Context) (newToken *EntryToken, oldToken *EntryToken, err error)
CreatePersonalAccessToken(ctx context.Context, username string, userId int, name string, expiresAt time.Time, scopes []string) (*EntryToken, error)
CreateGroupAccessToken(ctx context.Context, groupId string, name string, expiresAt time.Time, scopes []string, accessLevel AccessLevel) (*EntryToken, error)
CreateProjectAccessToken(ctx context.Context, projectId string, name string, expiresAt time.Time, scopes []string, accessLevel AccessLevel) (*EntryToken, error)
RevokePersonalAccessToken(ctx context.Context, tokenId int) error
RevokeProjectAccessToken(ctx context.Context, tokenId int, projectId string) error
RevokeGroupAccessToken(ctx context.Context, tokenId int, groupId string) error
GetUserIdByUsername(ctx context.Context, username string) (int, error)
GetGroupIdByPath(ctx context.Context, path string) (int, error)
CreateGroupServiceAccountAccessToken(ctx context.Context, group string, groupId string, userId int, name string, expiresAt time.Time, scopes []string) (*EntryToken, error)
CreateUserServiceAccountAccessToken(ctx context.Context, username string, userId int, name string, expiresAt time.Time, scopes []string) (*EntryToken, error)
RevokeUserServiceAccountAccessToken(ctx context.Context, token string) error
RevokeGroupServiceAccountAccessToken(ctx context.Context, token string) error
}
type gitlabClient struct {
client *g.Client
httpClient *http.Client
config *EntryConfig
logger hclog.Logger
}
func (gc *gitlabClient) GetGroupIdByPath(ctx context.Context, path string) (groupId int, err error) {
defer func() {
gc.logger.Debug("Get group id by path", "path", path, "groupId", groupId, "error", err)
}()
l := &g.ListGroupsOptions{
Search: g.Ptr(path),
}
g, _, err := gc.client.Groups.ListGroups(l)
if err != nil {
return 0, fmt.Errorf("%v", err)
}
if len(g) == 0 {
return 0, fmt.Errorf("path '%s' not found: %w", path, ErrInvalidValue)
}
groupId = g[0].ID
return groupId, nil
}
func (gc *gitlabClient) GitlabClient(ctx context.Context) *g.Client {
return gc.client
}
func (gc *gitlabClient) CreateGroupServiceAccountAccessToken(ctx context.Context, path string, groupId string, userId int, name string, expiresAt time.Time, scopes []string) (et *EntryToken, err error) {
var at *g.PersonalAccessToken
defer func() {
gc.logger.Debug("Created group service access token", "pat", at, "et", et, "path", path, "groupId", groupId, "userId", userId, "name", name, "expiresAt", expiresAt, "scopes", scopes, "error", err)
}()
at, _, err = gc.client.Groups.CreateServiceAccountPersonalAccessToken(groupId, userId, &g.CreateServiceAccountPersonalAccessTokenOptions{
Name: g.Ptr(name),
ExpiresAt: (*g.ISOTime)(&expiresAt),
Scopes: &scopes,
})
if err == nil {
et = &EntryToken{
TokenID: at.ID,
UserID: userId,
ParentID: groupId,
Path: path,
Name: name,
Token: at.Token,
TokenType: TokenTypeGroupServiceAccount,
CreatedAt: at.CreatedAt,
ExpiresAt: (*time.Time)(at.ExpiresAt),
Scopes: scopes,
AccessLevel: AccessLevelUnknown,
}
}
return et, err
}
func (gc *gitlabClient) CreateUserServiceAccountAccessToken(ctx context.Context, username string, userId int, name string, expiresAt time.Time, scopes []string) (et *EntryToken, err error) {
defer func() {
gc.logger.Debug("Created user service access token", "et", et, "username", username, "userId", userId, "name", name, "expiresAt", expiresAt, "scopes", scopes, "error", err)
}()
et, err = gc.CreatePersonalAccessToken(ctx, username, userId, name, expiresAt, scopes)
if err == nil && et != nil {
et.TokenType = TokenTypeUserServiceAccount
}
return et, err
}
func (gc *gitlabClient) RevokeUserServiceAccountAccessToken(ctx context.Context, token string) (err error) {
defer func() { gc.logger.Debug("Revoke user service account token", "token", token, "error", err) }()
if token == "" {
err = fmt.Errorf("%w: empty token", ErrNilValue)
return err
}
var c *g.Client
if c, err = newGitlabClient(&EntryConfig{
BaseURL: gc.config.BaseURL,
Token: token,
}, gc.httpClient); err == nil {
_, err = c.PersonalAccessTokens.RevokePersonalAccessTokenSelf()
}
return err
}
func (gc *gitlabClient) RevokeGroupServiceAccountAccessToken(ctx context.Context, token string) (err error) {
defer func() { gc.logger.Debug("Revoke group service account token", "token", token, "error", err) }()
if token == "" {
err = fmt.Errorf("%w: empty token", ErrNilValue)
return err
}
var c *g.Client
if c, err = newGitlabClient(&EntryConfig{
BaseURL: gc.config.BaseURL,
Token: token,
}, gc.httpClient); err == nil {
_, err = c.PersonalAccessTokens.RevokePersonalAccessTokenSelf()
}
return err
}
func (gc *gitlabClient) CurrentTokenInfo(ctx context.Context) (et *EntryToken, err error) {
var pat *g.PersonalAccessToken
defer func() { gc.logger.Debug("Current token info", "token", et, "error", err) }()
pat, _, err = gc.client.PersonalAccessTokens.GetSinglePersonalAccessToken()
if err != nil {
return nil, err
}
et = &EntryToken{
TokenID: pat.ID,
UserID: pat.UserID,
ParentID: "",
Path: "",
Name: pat.Name,
Token: pat.Token,
TokenType: TokenTypePersonal,
CreatedAt: pat.CreatedAt,
ExpiresAt: (*time.Time)(pat.ExpiresAt),
Scopes: pat.Scopes,
AccessLevel: "",
}
return et, nil
}
func (gc *gitlabClient) RotateCurrentToken(ctx context.Context) (token *EntryToken, currentEntryToken *EntryToken, err error) {
var expiresAt time.Time
defer func() {
gc.logger.Debug("Rotate current token", "token", token, "currentEntryToken", currentEntryToken, "expiresAt", expiresAt, "error", err)
}()
currentEntryToken, err = gc.CurrentTokenInfo(ctx)
if err != nil {
return nil, nil, err
}
var usr *g.User
usr, _, err = gc.client.Users.GetUser(currentEntryToken.UserID, g.GetUsersOptions{})
if err != nil {
return nil, nil, err
}
var pat *g.PersonalAccessToken
var durationTTL = currentEntryToken.ExpiresAt.Sub(*currentEntryToken.CreatedAt)
_, expiresAt, _ = calculateGitlabTTL(durationTTL, TimeFromContext(ctx))
pat, _, err = gc.client.PersonalAccessTokens.RotatePersonalAccessToken(
currentEntryToken.TokenID,
&g.RotatePersonalAccessTokenOptions{ExpiresAt: (*g.ISOTime)(&expiresAt)},
)
if err != nil {
return nil, nil, err
}
token = &EntryToken{
TokenID: pat.ID,
UserID: pat.UserID,
ParentID: "",
Path: usr.Username,
Name: pat.Name,
Token: pat.Token,
TokenType: TokenTypePersonal,
CreatedAt: pat.CreatedAt,
ExpiresAt: (*time.Time)(pat.ExpiresAt),
Scopes: pat.Scopes,
AccessLevel: AccessLevelUnknown,
}
gc.config.Token = token.Token
gc.config.TokenId = token.TokenID
gc.config.Scopes = token.Scopes
if token.CreatedAt != nil {
gc.config.TokenCreatedAt = *token.CreatedAt
}
if token.ExpiresAt != nil {
gc.config.TokenExpiresAt = *token.ExpiresAt
}
gc.client = nil
return token, currentEntryToken, err
}
func (gc *gitlabClient) GetUserIdByUsername(ctx context.Context, username string) (userId int, err error) {
defer func() {
gc.logger.Debug("Get user id by username", "username", username, "userId", userId, "error", err)
}()
l := &g.ListUsersOptions{
Username: g.Ptr(username),
}
u, _, err := gc.client.Users.ListUsers(l)
if err != nil {
return 0, fmt.Errorf("%v", err)
}
if len(u) == 0 {
return 0, fmt.Errorf("username '%s' not found: %w", username, ErrInvalidValue)
}
userId = u[0].ID
return userId, nil
}
func (gc *gitlabClient) CreatePersonalAccessToken(ctx context.Context, username string, userId int, name string, expiresAt time.Time, scopes []string) (et *EntryToken, err error) {
var at *g.PersonalAccessToken
defer func() {
gc.logger.Debug("Create personal access token", "pat", at, "et", et, "username", username, "userId", userId, "name", name, "expiresAt", expiresAt, "scopes", scopes, "error", err)
}()
at, _, err = gc.client.Users.CreatePersonalAccessToken(userId, &g.CreatePersonalAccessTokenOptions{
Name: g.Ptr(name),
ExpiresAt: (*g.ISOTime)(&expiresAt),
Scopes: &scopes,
})
if err != nil {
return nil, err
}
et = &EntryToken{
TokenID: at.ID,
UserID: userId,
ParentID: "",
Path: username,
Name: name,
Token: at.Token,
TokenType: TokenTypePersonal,
CreatedAt: at.CreatedAt,
ExpiresAt: (*time.Time)(at.ExpiresAt),
Scopes: scopes,
AccessLevel: AccessLevelUnknown,
}
return et, nil
}
func (gc *gitlabClient) CreateGroupAccessToken(ctx context.Context, groupId string, name string, expiresAt time.Time, scopes []string, accessLevel AccessLevel) (et *EntryToken, err error) {
var at *g.GroupAccessToken
defer func() {
gc.logger.Debug("Create group access token", "gat", at, "et", et, "groupId", groupId, "name", name, "expiresAt", expiresAt, "scopes", scopes, "accessLevel", accessLevel, "error", err)
}()
var al = new(g.AccessLevelValue)
*al = g.AccessLevelValue(accessLevel.Value())
at, _, err = gc.client.GroupAccessTokens.CreateGroupAccessToken(groupId, &g.CreateGroupAccessTokenOptions{
Name: g.Ptr(name),
Scopes: &scopes,
ExpiresAt: (*g.ISOTime)(&expiresAt),
AccessLevel: al,
})
if err != nil {
return nil, err
}
et = &EntryToken{
TokenID: at.ID,
UserID: 0,
ParentID: groupId,
Path: groupId,
Name: name,
Token: at.Token,
TokenType: TokenTypeGroup,
CreatedAt: at.CreatedAt,
ExpiresAt: (*time.Time)(at.ExpiresAt),
Scopes: scopes,
AccessLevel: accessLevel,
}
return et, nil
}
func (gc *gitlabClient) CreateProjectAccessToken(ctx context.Context, projectId string, name string, expiresAt time.Time, scopes []string, accessLevel AccessLevel) (*EntryToken, error) {
var al = new(g.AccessLevelValue)
*al = g.AccessLevelValue(accessLevel.Value())
at, _, err := gc.client.ProjectAccessTokens.CreateProjectAccessToken(projectId, &g.CreateProjectAccessTokenOptions{
Name: g.Ptr(name),
Scopes: &scopes,
ExpiresAt: (*g.ISOTime)(&expiresAt),
AccessLevel: al,
})
if err != nil {
return nil, err
}
return &EntryToken{
TokenID: at.ID,
UserID: 0,
ParentID: projectId,
Path: projectId,
Name: name,
Token: at.Token,
TokenType: TokenTypeProject,
CreatedAt: at.CreatedAt,
ExpiresAt: (*time.Time)(at.ExpiresAt),
Scopes: scopes,
AccessLevel: accessLevel,
}, nil
}
func (gc *gitlabClient) RevokePersonalAccessToken(ctx context.Context, tokenId int) (err error) {
defer func() {
gc.logger.Debug("Revoke personal access token", "tokenId", tokenId, "error", err)
}()
var resp *g.Response
resp, err = gc.client.PersonalAccessTokens.RevokePersonalAccessToken(tokenId)
if resp != nil && resp.StatusCode == http.StatusNotFound {
return fmt.Errorf("personal: %w", ErrAccessTokenNotFound)
}
if err != nil {
return err
}
return nil
}
func (gc *gitlabClient) RevokeProjectAccessToken(ctx context.Context, tokenId int, projectId string) (err error) {
defer func() {
gc.logger.Debug("Revoke project access token", "tokenId", tokenId, "error", err)
}()
var resp *g.Response
resp, err = gc.client.ProjectAccessTokens.RevokeProjectAccessToken(projectId, tokenId)
if resp != nil && resp.StatusCode == http.StatusNotFound {
return fmt.Errorf("project: %w", ErrAccessTokenNotFound)
}
if err != nil {
return err
}
return nil
}
func (gc *gitlabClient) RevokeGroupAccessToken(ctx context.Context, tokenId int, groupId string) (err error) {
defer func() {
gc.logger.Debug("Revoke group access token", "tokenId", tokenId, "error", err)
}()
var resp *g.Response
resp, err = gc.client.GroupAccessTokens.RevokeGroupAccessToken(groupId, tokenId)
if resp != nil && resp.StatusCode == http.StatusNotFound {
return fmt.Errorf("group: %w", ErrAccessTokenNotFound)
}
if err != nil {
return err
}
return nil
}
func (gc *gitlabClient) Valid(ctx context.Context) bool {
return gc.client != nil && gc.config != nil
}
var _ Client = new(gitlabClient)
func newGitlabClient(config *EntryConfig, httpClient *http.Client) (gc *g.Client, err error) {
if "" == strings.TrimSpace(config.BaseURL) {
err = errors.Join(err, fmt.Errorf("gitlab base url: %w", ErrInvalidValue))
}
if "" == strings.TrimSpace(config.Token) {
err = errors.Join(err, fmt.Errorf("gitlab token: %w", ErrInvalidValue))
}
if err != nil {
return nil, err
}
var opts = []g.ClientOptionFunc{
g.WithBaseURL(fmt.Sprintf("%s/api/v4", strings.TrimSuffix(config.BaseURL, "/"))),
g.WithCustomLimiter(rate.NewLimiter(rate.Inf, 0)),
}
if httpClient != nil {
opts = append(opts, g.WithHTTPClient(httpClient))
}
return g.NewClient(config.Token, opts...)
}
func NewGitlabClient(config *EntryConfig, httpClient *http.Client, logger hclog.Logger) (client Client, err error) {
if config == nil {
return nil, fmt.Errorf("configure the backend first, config: %w", ErrNilValue)
}
if logger == nil {
logger = logging.NewVaultLoggerWithWriter(io.Discard, hclog.NoLevel)
}
var gc *g.Client
if gc, err = newGitlabClient(config, httpClient); err != nil {
return nil, err
}
return &gitlabClient{client: gc, config: config, logger: logger, httpClient: httpClient}, err
}