-
Notifications
You must be signed in to change notification settings - Fork 3
/
client_kvv2.go
366 lines (294 loc) · 8.14 KB
/
client_kvv2.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
package hashicorp
import (
"context"
"fmt"
"net/url"
"path"
"strings"
"github.com/hashicorp/vault/api"
"github.com/sirupsen/logrus"
)
type KVv2Client struct {
*api.Client
cfg *ClientConfig
mountPath, basePath string
logger logrus.FieldLogger
}
func NewKVv2Client(cfg *ClientConfig) (*KVv2Client, error) {
hashicorpConfig, err := cfg.ToHashicorpConfig()
if err != nil {
return nil, err
}
client, err := api.NewClient(hashicorpConfig)
if err != nil {
return nil, err
}
c := &KVv2Client{
cfg: cfg,
Client: client,
}
c.SetLogger(logrus.StandardLogger())
return c, nil
}
func (c *KVv2Client) Logger() logrus.FieldLogger {
return c.logger
}
func (c *KVv2Client) SetLogger(logger logrus.FieldLogger) {
c.logger = logger.WithField("component", "hashicorp.kvv2-client")
}
func (c *KVv2Client) Init(ctx context.Context) error {
err := c.validateAddress()
if err != nil {
return err
}
err = c.initAuth(ctx)
if err != nil {
return err
}
err = c.initKVv2(ctx)
if err != nil {
return err
}
return nil
}
func (c *KVv2Client) validateAddress() (err error) {
logger := c.logger.WithField("address", c.cfg.Address)
logger.Info("validate Vault address")
defer func() {
if err != nil {
logger.WithError(err).Error("invalid Vault address")
}
}()
if c.cfg.Address == "" {
err = fmt.Errorf("missing Vault address")
return err
}
// validate vault address
_, err = url.Parse(c.cfg.Address)
if err != nil {
return fmt.Errorf("invalid Vault address %q [err=%v]", c.cfg.Address, err)
}
return nil
}
func (c *KVv2Client) initAuth(ctx context.Context) (err error) {
c.logger.Info("authenticate on Vault")
defer func() {
if err != nil {
c.logger.WithError(err).Error("authentication failed")
}
}()
if c.cfg.Auth == nil {
err = fmt.Errorf("vault authentication credentials missing")
return
}
// Vault token has been provided
if c.cfg.Auth.Token != "" {
c.SetToken(c.cfg.Auth.Token)
c.logger.
WithField("auth", "token").
Info("authentication succeeded")
return nil
}
// GitHub token has been provided
if c.cfg.Auth.GitHubToken != "" {
logger := c.logger.WithField("auth", "github")
// Perform Github login
ghSecAuth, ghErr := c.GithubLogin(ctx)
if ghErr != nil {
logger.WithError(ghErr).Errorf("authentication failed")
return fmt.Errorf("GitHub authentication failed %v", ghErr)
}
logger.Infof("authentication succeeded")
// Set token for subsequent requests
c.SetToken(ghSecAuth.ClientToken)
return nil
}
err = fmt.Errorf("vault authentication credentials missing")
return
}
func (c *KVv2Client) initKVv2(ctx context.Context) error {
c.logger.WithField("path", c.cfg.Path).Info("check Vault mount is kv-v2")
mountPath, ok, err := c.IsKVv2(ctx, c.cfg.Path)
if err != nil {
c.logger.WithError(err).Errorf("failed to check Vault mount")
return err
}
logger := c.logger.WithField("mount", mountPath)
if !ok {
logger.Errorf("Vault mount is not a kv-v2 secret engine")
return fmt.Errorf("mount %q is not a kv-v2 secret engine", mountPath)
}
c.mountPath = mountPath
c.basePath = strings.TrimPrefix(c.cfg.Path, mountPath)
logger.WithField("base.path", "c.basePath").Infof("Vault mount is kv-v2")
return nil
}
func (c *KVv2Client) GithubLogin(ctx context.Context) (*api.SecretAuth, error) {
secret, err := c.Client.Logical().WriteWithContext(
ctx,
"auth/github/login",
map[string]interface{}{
"token": strings.TrimSpace(c.cfg.Auth.GitHubToken),
},
)
if err != nil {
return nil, err
}
if secret == nil {
return nil, fmt.Errorf("empty response")
}
return secret.Auth, nil
}
func (c *KVv2Client) SetToken(token string) {
c.Client.SetToken(token)
}
func (c *KVv2Client) LookupToken(ctx context.Context, token string) (*api.Secret, error) {
return c.Client.Logical().WriteWithContext(
ctx,
"auth/token/lookup",
map[string]interface{}{
"token": token,
},
)
}
func (c *KVv2Client) UnwrapToken(ctx context.Context, token string) (*api.Secret, error) {
return c.Client.Logical().UnwrapWithContext(ctx, token)
}
func (c *KVv2Client) HealthCheck(ctx context.Context) error {
resp, err := c.Client.Sys().HealthWithContext(ctx)
if err != nil {
return err
}
if !resp.Initialized {
return fmt.Errorf("hashicorp client is not initialized")
}
return nil
}
func (c *KVv2Client) Put(ctx context.Context, id string, data map[string]interface{}) (*api.Secret, error) {
return c.Client.Logical().WriteWithContext(
ctx,
c.dataPath(id),
map[string]interface{}{
"data": data,
},
)
}
func (c *KVv2Client) Get(ctx context.Context, pth, version string) (secret *api.Secret, data, metadata map[string]interface{}, err error) {
query := map[string][]string{}
if version != "" {
query["version"] = []string{version}
}
secret, err = c.Client.Logical().ReadWithDataWithContext(
ctx,
c.dataPath(pth),
query,
)
if err != nil {
return
}
if secret == nil || secret.Data["data"] == nil {
return secret, nil, nil, fmt.Errorf("empty secret at path %q", pth)
}
var ok bool
data, ok = secret.Data["data"].(map[string]interface{})
if !ok {
return secret, nil, nil, fmt.Errorf("invalid hashicorp vault response data: %v", secret.Data["data"])
}
metadata, ok = secret.Data["metadata"].(map[string]interface{})
if !ok {
return secret, nil, nil, fmt.Errorf("invalid hashicorp vault response metadata: %v", secret.Data["metadata"])
}
return
}
func (c *KVv2Client) List(ctx context.Context, pth string) ([]string, error) {
secret, err := c.Client.Logical().ListWithContext(
ctx,
c.metadaDataPath(pth),
)
if err != nil {
return nil, err
}
return extractListData(secret)
}
func extractListData(secret *api.Secret) ([]string, error) {
if secret == nil || secret.Data == nil {
return nil, fmt.Errorf("empty response")
}
keys, ok := secret.Data["keys"]
if !ok {
return nil, fmt.Errorf("invalid response body missing \"keys\" field")
}
ikeys, ok := keys.([]interface{})
if !ok {
return nil, fmt.Errorf("invalid \"keys\" format: %v", keys)
}
skeys := make([]string, len(ikeys))
for i, key := range ikeys {
skeys[i] = fmt.Sprintf("%v", key)
}
return skeys, nil
}
func (c *KVv2Client) Delete(ctx context.Context, id string) error {
return fmt.Errorf("not implemented error")
}
func (c *KVv2Client) dataPath(id string) string {
return path.Join(c.mountPath, "data", c.basePath, id)
}
func (c *KVv2Client) metadaDataPath(id string) string {
return path.Join(c.mountPath, "metadata", c.basePath, id)
}
func (c *KVv2Client) kvPreflightVersionRequest(ctx context.Context, pth string) (mountPath string, version int, err error) {
// We don't want to use a wrapping call here so save any custom value and
// restore after
currentWrappingLookupFunc := c.Client.CurrentWrappingLookupFunc()
c.Client.SetWrappingLookupFunc(nil)
defer c.Client.SetWrappingLookupFunc(currentWrappingLookupFunc)
currentOutputCurlString := c.Client.OutputCurlString()
c.Client.SetOutputCurlString(false)
defer c.Client.SetOutputCurlString(currentOutputCurlString)
r := c.Client.NewRequest("GET", path.Join("/v1/sys/internal/ui/mounts", pth))
resp, err := c.Client.RawRequestWithContext(ctx, r) //nolint
if resp != nil {
defer resp.Body.Close()
}
if err != nil {
// If we get a 404 we are using an older version of vault, default to
// version 1
if resp != nil && resp.StatusCode == 404 {
return "", 1, nil
}
return "", 0, err
}
secret, err := api.ParseSecret(resp.Body)
if err != nil {
return "", 0, err
}
if secret == nil {
return "", 0, fmt.Errorf("nil response from pre-flight request")
}
if mountPathRaw, ok := secret.Data["path"]; ok {
mountPath = mountPathRaw.(string)
}
options := secret.Data["options"]
if options == nil {
return mountPath, 1, nil
}
versionRaw := options.(map[string]interface{})["version"]
if versionRaw == nil {
return mountPath, 1, nil
}
switch versionRaw.(string) {
case "", "1":
return mountPath, 1, nil
case "2":
return mountPath, 2, nil
}
return mountPath, 1, nil
}
func (c *KVv2Client) IsKVv2(ctx context.Context, pth string) (mount string, isKVv2 bool, err error) {
mountPath, version, err := c.kvPreflightVersionRequest(ctx, pth)
if err != nil {
return "", false, err
}
return mountPath, version == 2, nil
}