-
-
Notifications
You must be signed in to change notification settings - Fork 6
/
path_config.go
241 lines (210 loc) · 7.17 KB
/
path_config.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
package gitlab
import (
"context"
"fmt"
"net/http"
"strconv"
"strings"
"time"
"github.com/hashicorp/go-multierror"
"github.com/hashicorp/vault/sdk/framework"
"github.com/hashicorp/vault/sdk/logical"
)
const (
PathConfigStorage = "config"
)
var (
fieldSchemaConfig = map[string]*framework.FieldSchema{
"token": {
Type: framework.TypeString,
Description: "The token to access Gitlab API",
Required: true,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Token",
Sensitive: true,
},
},
"base_url": {
Type: framework.TypeString,
Required: true,
Description: `The address to access Gitlab.`,
},
"auto_rotate_token": {
Type: framework.TypeBool,
Default: false,
Description: `Should we autorotate the token when it's close to expiry?`,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Auto rotate token",
},
},
"auto_rotate_before": {
Type: framework.TypeDurationSecond,
Description: `How much time should be remaining on the token validity before we should rotate it? Minimum can be set to 24h and maximum to 730h`,
Default: DefaultConfigFieldAccessTokenRotate,
DisplayAttrs: &framework.DisplayAttributes{
Name: "Auto rotate before",
},
},
}
)
func (b *Backend) pathConfigDelete(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
b.lockClientMutex.RLock()
defer b.lockClientMutex.RUnlock()
config, err := getConfig(ctx, req.Storage)
if err != nil {
return nil, err
}
if config == nil {
return logical.ErrorResponse(ErrBackendNotConfigured.Error()), nil
}
if err = req.Storage.Delete(ctx, PathConfigStorage); err != nil {
return nil, err
}
event(ctx, b.Backend, "config-delete", map[string]string{
"path": "config",
})
return nil, nil
}
func (b *Backend) pathConfigRead(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
b.lockClientMutex.RLock()
defer b.lockClientMutex.RUnlock()
config, err := getConfig(ctx, req.Storage)
if err != nil {
return nil, err
}
if config == nil {
return logical.ErrorResponse(ErrBackendNotConfigured.Error()), nil
}
lrd := config.LogicalResponseData()
b.Logger().Debug("Reading configuration info", "info", lrd)
return &logical.Response{
Data: config.LogicalResponseData(),
}, nil
}
func (b *Backend) pathConfigWrite(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
var warnings []string
var autoTokenRotateRaw, autoTokenRotateTtlOk = data.GetOk("auto_rotate_before")
var token, tokenOk = data.GetOk("token")
var err error
if !tokenOk {
err = multierror.Append(err, fmt.Errorf("token: %w", ErrFieldRequired))
}
var config = EntryConfig{
BaseURL: data.Get("base_url").(string),
AutoRotateToken: data.Get("auto_rotate_token").(bool),
}
if autoTokenRotateTtlOk {
atr, _ := convertToInt(autoTokenRotateRaw)
if atr > int(DefaultAutoRotateBeforeMaxTTL.Seconds()) {
err = multierror.Append(err, fmt.Errorf("auto_rotate_token can not be bigger than %s: %w", DefaultAutoRotateBeforeMaxTTL, ErrInvalidValue))
} else if atr <= int(DefaultAutoRotateBeforeMinTTL.Seconds())-1 {
err = multierror.Append(err, fmt.Errorf("auto_rotate_token can not be less than %s: %w", DefaultAutoRotateBeforeMinTTL, ErrInvalidValue))
} else {
config.AutoRotateBefore = time.Duration(atr) * time.Second
}
} else {
config.AutoRotateBefore = DefaultAutoRotateBeforeMinTTL
warnings = append(warnings, fmt.Sprintf("auto_rotate_token not specified setting to %s", DefaultAutoRotateBeforeMinTTL))
}
if err != nil {
return nil, err
}
config.Token = token.(string)
var httpClient *http.Client
var client Client
httpClient, _ = HttpClientFromContext(ctx)
if client, _ = GitlabClientFromContext(ctx); client == nil {
if client, err = NewGitlabClient(&config, httpClient, b.Logger()); err == nil {
b.SetClient(client)
}
}
var et *EntryToken
et, err = client.CurrentTokenInfo()
if err != nil {
return nil, fmt.Errorf("token cannot be validated: %s", ErrInvalidValue)
}
config.TokenCreatedAt = *et.CreatedAt
config.TokenExpiresAt = *et.ExpiresAt
config.TokenId = et.TokenID
config.Scopes = et.Scopes
b.lockClientMutex.Lock()
defer b.lockClientMutex.Unlock()
err = saveConfig(ctx, config, req.Storage)
if err != nil {
return nil, err
}
event(ctx, b.Backend, "config-write", map[string]string{
"path": "config",
"auto_rotate_token": strconv.FormatBool(config.AutoRotateToken),
"auto_rotate_before": config.AutoRotateBefore.String(),
"base_url": config.BaseURL,
"token_id": strconv.Itoa(config.TokenId),
"created_at": config.TokenCreatedAt.Format(time.RFC3339),
"expires_at": config.TokenExpiresAt.Format(time.RFC3339),
"scopes": strings.Join(config.Scopes, ", "),
})
b.SetClient(nil)
lrd := config.LogicalResponseData()
b.Logger().Debug("Wrote new config", "lrd", lrd, "warnings", warnings)
return &logical.Response{
Data: lrd,
Warnings: warnings,
}, nil
}
func pathConfig(b *Backend) *framework.Path {
return &framework.Path{
HelpSynopsis: strings.TrimSpace(pathConfigHelpSynopsis),
HelpDescription: strings.TrimSpace(pathConfigHelpDescription),
Pattern: fmt.Sprintf("%s$", PathConfigStorage),
Fields: fieldSchemaConfig,
DisplayAttrs: &framework.DisplayAttributes{
OperationPrefix: operationPrefixGitlabAccessTokens,
},
Operations: map[logical.Operation]framework.OperationHandler{
logical.UpdateOperation: &framework.PathOperation{
Callback: b.pathConfigWrite,
DisplayAttrs: &framework.DisplayAttributes{OperationVerb: "configure"},
Summary: "Configure Backend level settings that are applied to all credentials.",
Responses: map[int][]framework.Response{
http.StatusNoContent: {{
Description: http.StatusText(http.StatusNoContent),
}},
},
},
logical.ReadOperation: &framework.PathOperation{
Callback: b.pathConfigRead,
DisplayAttrs: &framework.DisplayAttributes{
OperationVerb: "read",
OperationSuffix: "configuration",
},
Summary: "Read the Backend level settings.",
Responses: map[int][]framework.Response{
http.StatusOK: {{
Description: http.StatusText(http.StatusOK),
Fields: fieldSchemaConfig,
}},
},
},
logical.DeleteOperation: &framework.PathOperation{
Callback: b.pathConfigDelete,
DisplayAttrs: &framework.DisplayAttributes{
OperationVerb: "delete",
OperationSuffix: "configuration",
},
Summary: "Delete the Backend level settings.",
Responses: map[int][]framework.Response{
http.StatusNoContent: {{
Description: http.StatusText(http.StatusNoContent),
}},
},
},
},
}
}
const pathConfigHelpSynopsis = `Configure the Gitlab Access Tokens Backend.`
const pathConfigHelpDescription = `
The Gitlab Access Tokens auth Backend requires credentials for managing
private and group access tokens for Gitlab. This endpoint
is used to configure those credentials and the default values for the Backend input general.
You must specify expected Gitlab token with access to allow Vault to create tokens.
`