-
Notifications
You must be signed in to change notification settings - Fork 582
/
vault.go
508 lines (459 loc) · 16.7 KB
/
vault.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
package config
import (
"os"
"path"
"regexp"
"strings"
"github.com/SAP/jenkins-library/pkg/config/interpolation"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/piperutils"
"github.com/SAP/jenkins-library/pkg/vault"
"github.com/hashicorp/vault/api"
)
const (
vaultRootPaths = "vaultRootPaths"
vaultTestCredentialPath = "vaultTestCredentialPath"
vaultCredentialPath = "vaultCredentialPath"
vaultTestCredentialKeys = "vaultTestCredentialKeys"
vaultCredentialKeys = "vaultCredentialKeys"
vaultAppRoleID = "vaultAppRoleID"
vaultAppRoleSecretID = "vaultAppRoleSecreId"
vaultServerUrl = "vaultServerUrl"
vaultNamespace = "vaultNamespace"
vaultBasePath = "vaultBasePath"
vaultPipelineName = "vaultPipelineName"
vaultPath = "vaultPath"
skipVault = "skipVault"
vaultDisableOverwrite = "vaultDisableOverwrite"
vaultTestCredentialEnvPrefix = "vaultTestCredentialEnvPrefix"
vaultCredentialEnvPrefix = "vaultCredentialEnvPrefix"
vaultTestCredentialEnvPrefixDefault = "PIPER_TESTCREDENTIAL_"
VaultCredentialEnvPrefixDefault = "PIPER_VAULTCREDENTIAL_"
vaultSecretName = ".+VaultSecretName$"
)
var (
vaultFilter = []string{
vaultRootPaths,
vaultAppRoleID,
vaultAppRoleSecretID,
vaultServerUrl,
vaultNamespace,
vaultBasePath,
vaultPipelineName,
vaultPath,
skipVault,
vaultDisableOverwrite,
vaultTestCredentialPath,
vaultTestCredentialKeys,
vaultTestCredentialEnvPrefix,
vaultCredentialPath,
vaultCredentialKeys,
vaultCredentialEnvPrefix,
vaultSecretName,
}
// VaultRootPaths are the lookup paths piper tries to use during the vault lookup.
// A path is only used if it's variables can be interpolated from the config
VaultRootPaths = []string{
"$(vaultPath)",
"$(vaultBasePath)/$(vaultPipelineName)",
"$(vaultBasePath)/GROUP-SECRETS",
}
// VaultSecretFileDirectory holds the directory for the current step run to temporarily store secret files fetched from vault
VaultSecretFileDirectory = ""
)
// VaultCredentials hold all the auth information needed to fetch configuration from vault
type VaultCredentials struct {
AppRoleID string
AppRoleSecretID string
VaultToken string
}
// VaultClient interface for mocking
type VaultClient interface {
GetKvSecret(string) (map[string]string, error)
MustRevokeToken()
GetOIDCTokenByValidation(string) (string, error)
}
func (s *StepConfig) mixinVaultConfig(parameters []StepParameters, configs ...map[string]interface{}) {
for _, config := range configs {
s.mixIn(config, vaultFilter, StepData{})
// when an empty filter is returned we skip the mixin call since an empty filter will allow everything
if referencesFilter := getFilterForResourceReferences(parameters); len(referencesFilter) > 0 {
s.mixIn(config, referencesFilter, StepData{})
}
}
}
func GetVaultClientFromConfig(config map[string]interface{}, creds VaultCredentials) (VaultClient, error) {
address, addressOk := config["vaultServerUrl"].(string)
// if vault isn't used it's not an error
if !addressOk || creds.VaultToken == "" && (creds.AppRoleID == "" || creds.AppRoleSecretID == "") {
log.Entry().Debug("Vault not configured")
return nil, nil
}
log.Entry().Info("Logging into Vault")
log.Entry().Debugf(" with URL %s", address)
namespace := ""
// namespaces are only available in vault enterprise so using them should be optional
if config["vaultNamespace"] != nil {
namespace = config["vaultNamespace"].(string)
log.Entry().Debugf(" with namespace %s", namespace)
}
var client VaultClient
var err error
clientConfig := &vault.Config{Config: &api.Config{Address: address}, Namespace: namespace}
if creds.VaultToken != "" {
log.Entry().Debugf(" with Token authentication")
client, err = vault.NewClient(clientConfig, creds.VaultToken)
} else {
log.Entry().Debugf(" with AppRole authentication")
client, err = vault.NewClientWithAppRole(clientConfig, creds.AppRoleID, creds.AppRoleSecretID)
}
if err != nil {
log.Entry().Info(" failed")
return nil, err
}
log.Entry().Info(" succeeded")
return client, nil
}
func resolveAllVaultReferences(config *StepConfig, client VaultClient, params []StepParameters) {
for _, param := range params {
if ref := param.GetReference("vaultSecret"); ref != nil {
resolveVaultReference(ref, config, client, param)
}
if ref := param.GetReference("vaultSecretFile"); ref != nil {
resolveVaultReference(ref, config, client, param)
}
}
}
func resolveVaultReference(ref *ResourceReference, config *StepConfig, client VaultClient, param StepParameters) {
vaultDisableOverwrite, _ := config.Config["vaultDisableOverwrite"].(bool)
if _, ok := config.Config[param.Name].(string); vaultDisableOverwrite && ok {
log.Entry().Debugf("Not fetching '%s' from Vault since it has already been set", param.Name)
return
}
log.Entry().Infof("Resolving '%s'", param.Name)
var secretValue *string
for _, vaultPath := range getSecretReferencePaths(ref, config.Config) {
// it should be possible to configure the root path were the secret is stored
vaultPath, ok := interpolation.ResolveString(vaultPath, config.Config)
if !ok {
continue
}
secretValue = lookupPath(client, vaultPath, ¶m)
if secretValue != nil {
log.Entry().Infof(" succeeded with Vault path '%s'", vaultPath)
if ref.Type == "vaultSecret" {
config.Config[param.Name] = *secretValue
} else if ref.Type == "vaultSecretFile" {
filePath, err := createTemporarySecretFile(param.Name, *secretValue)
if err != nil {
log.Entry().WithError(err).Warnf("Couldn't create temporary secret file for '%s'", param.Name)
return
}
config.Config[param.Name] = filePath
}
break
}
}
if secretValue == nil {
log.Entry().Warn(" failed")
}
}
func resolveVaultTestCredentialsWrapper(config *StepConfig, client VaultClient) {
log.Entry().Infof("Resolving test credentials wrapper")
resolveVaultCredentialsWrapperBase(config, client, vaultTestCredentialPath, vaultTestCredentialKeys, vaultTestCredentialEnvPrefix, resolveVaultTestCredentials)
}
func resolveVaultCredentialsWrapper(config *StepConfig, client VaultClient) {
log.Entry().Infof("Resolving credentials wrapper")
resolveVaultCredentialsWrapperBase(config, client, vaultCredentialPath, vaultCredentialKeys, vaultCredentialEnvPrefix, resolveVaultCredentials)
}
func resolveVaultCredentialsWrapperBase(
config *StepConfig, client VaultClient,
vaultCredPath, vaultCredKeys, vaultCredEnvPrefix string,
resolveVaultCredentials func(config *StepConfig, client VaultClient),
) {
switch config.Config[vaultCredPath].(type) {
case string:
resolveVaultCredentials(config, client)
case []interface{}:
vaultCredentialPathCopy := config.Config[vaultCredPath].([]interface{})
vaultCredentialKeysCopy, keysOk := config.Config[vaultCredKeys].([]interface{})
vaultCredentialEnvPrefixCopy, prefixOk := config.Config[vaultCredEnvPrefix].([]interface{})
if !keysOk {
log.Entry().Debugf(" failed, unknown type of keys")
return
}
if len(vaultCredentialKeysCopy) != len(vaultCredentialPathCopy) {
log.Entry().Debugf(" failed, not same count of values and keys")
return
}
if prefixOk && len(vaultCredentialEnvPrefixCopy) != len(vaultCredentialPathCopy) {
log.Entry().Debugf(" failed, not same count of values and environment prefixes")
return
}
for i := 0; i < len(vaultCredentialPathCopy); i++ {
if prefixOk {
config.Config[vaultCredEnvPrefix] = vaultCredentialEnvPrefixCopy[i]
}
config.Config[vaultCredPath] = vaultCredentialPathCopy[i]
config.Config[vaultCredKeys] = vaultCredentialKeysCopy[i]
resolveVaultCredentials(config, client)
}
config.Config[vaultCredPath] = vaultCredentialPathCopy
config.Config[vaultCredKeys] = vaultCredentialKeysCopy
config.Config[vaultCredEnvPrefix] = vaultCredentialEnvPrefixCopy
default:
log.Entry().Debugf(" failed, unknown type of path")
return
}
}
// resolve test credential keys and expose as environment variables
func resolveVaultTestCredentials(config *StepConfig, client VaultClient) {
credPath, pathOk := config.Config[vaultTestCredentialPath].(string)
keys := getTestCredentialKeys(config)
if !(pathOk && keys != nil) || credPath == "" || len(keys) == 0 {
log.Entry().Debugf("Not fetching test credentials from Vault since they are not (properly) configured")
return
}
lookupPath := make([]string, 3)
lookupPath[0] = "$(vaultPath)/" + credPath
lookupPath[1] = "$(vaultBasePath)/$(vaultPipelineName)/" + credPath
lookupPath[2] = "$(vaultBasePath)/GROUP-SECRETS/" + credPath
for _, path := range lookupPath {
vaultPath, ok := interpolation.ResolveString(path, config.Config)
if !ok {
continue
}
secret, err := client.GetKvSecret(vaultPath)
if err != nil {
log.Entry().WithError(err).Debugf("Couldn't fetch secret at '%s'", vaultPath)
continue
}
if secret == nil {
continue
}
secretsResolved := false
secretsResolved = populateTestCredentialsAsEnvs(config, secret, keys)
if secretsResolved {
// prevent overwriting resolved secrets
// only allows vault test credentials on one / the same vault path
break
}
}
}
func resolveVaultCredentials(config *StepConfig, client VaultClient) {
credPath, pathOk := config.Config[vaultCredentialPath].(string)
keys := getCredentialKeys(config)
if !(pathOk && keys != nil) || credPath == "" || len(keys) == 0 {
log.Entry().Debugf("Not fetching credentials from vault since they are not (properly) configured")
return
}
lookupPath := make([]string, 3)
lookupPath[0] = "$(vaultPath)/" + credPath
lookupPath[1] = "$(vaultBasePath)/$(vaultPipelineName)/" + credPath
lookupPath[2] = "$(vaultBasePath)/GROUP-SECRETS/" + credPath
for _, path := range lookupPath {
vaultPath, ok := interpolation.ResolveString(path, config.Config)
if !ok {
continue
}
secret, err := client.GetKvSecret(vaultPath)
if err != nil {
log.Entry().WithError(err).Debugf("Couldn't fetch secret at '%s'", vaultPath)
continue
}
if secret == nil {
continue
}
secretsResolved := false
secretsResolved = populateCredentialsAsEnvs(config, secret, keys)
if secretsResolved {
// prevent overwriting resolved secrets
// only allows vault test credentials on one / the same vault path
break
}
}
}
func populateTestCredentialsAsEnvs(config *StepConfig, secret map[string]string, keys []string) (matched bool) {
vaultTestCredentialEnvPrefix, ok := config.Config["vaultTestCredentialEnvPrefix"].(string)
if !ok || len(vaultTestCredentialEnvPrefix) == 0 {
vaultTestCredentialEnvPrefix = vaultTestCredentialEnvPrefixDefault
}
for secretKey, secretValue := range secret {
for _, key := range keys {
if secretKey == key {
log.RegisterSecret(secretValue)
envVariable := vaultTestCredentialEnvPrefix + ConvertEnvVar(secretKey)
log.Entry().Debugf("Exposing test credential '%v' as '%v'", key, envVariable)
os.Setenv(envVariable, secretValue)
matched = true
}
}
}
return
}
func populateCredentialsAsEnvs(config *StepConfig, secret map[string]string, keys []string) (matched bool) {
vaultCredentialEnvPrefix, ok := config.Config["vaultCredentialEnvPrefix"].(string)
isCredentialEnvPrefixDefault := false
if !ok {
vaultCredentialEnvPrefix = VaultCredentialEnvPrefixDefault
isCredentialEnvPrefixDefault = true
}
for secretKey, secretValue := range secret {
for _, key := range keys {
if secretKey == key {
log.RegisterSecret(secretValue)
envVariable := vaultCredentialEnvPrefix + ConvertEnvVar(secretKey)
log.Entry().Debugf("Exposing general purpose credential '%v' as '%v'", key, envVariable)
os.Setenv(envVariable, secretValue)
log.RegisterSecret(piperutils.EncodeString(secretValue))
envVariable = vaultCredentialEnvPrefix + ConvertEnvVar(secretKey) + "_BASE64"
log.Entry().Debugf("Exposing general purpose base64 encoded credential '%v' as '%v'", key, envVariable)
os.Setenv(envVariable, piperutils.EncodeString(secretValue))
matched = true
}
}
}
// we always create a standard env variable with the default prefx so that
// we can always refer to it in steps if its to be hard-coded
if !isCredentialEnvPrefixDefault {
for secretKey, secretValue := range secret {
for _, key := range keys {
if secretKey == key {
log.RegisterSecret(secretValue)
envVariable := VaultCredentialEnvPrefixDefault + ConvertEnvVar(secretKey)
log.Entry().Debugf("Exposing general purpose credential '%v' as '%v'", key, envVariable)
os.Setenv(envVariable, secretValue)
log.RegisterSecret(piperutils.EncodeString(secretValue))
envVariable = VaultCredentialEnvPrefixDefault + ConvertEnvVar(secretKey) + "_BASE64"
log.Entry().Debugf("Exposing general purpose base64 encoded credential '%v' as '%v'", key, envVariable)
os.Setenv(envVariable, piperutils.EncodeString(secretValue))
matched = true
}
}
}
}
return
}
func getTestCredentialKeys(config *StepConfig) []string {
keysRaw, ok := config.Config[vaultTestCredentialKeys].([]interface{})
if !ok {
return nil
}
keys := make([]string, 0, len(keysRaw))
for _, keyRaw := range keysRaw {
key, ok := keyRaw.(string)
if !ok {
log.Entry().Warnf("%s needs to be an array of strings", vaultTestCredentialKeys)
return nil
}
keys = append(keys, key)
}
return keys
}
func getCredentialKeys(config *StepConfig) []string {
keysRaw, ok := config.Config[vaultCredentialKeys].([]interface{})
if !ok {
log.Entry().Debugf("Not fetching general purpose credentials from vault since they are not (properly) configured")
return nil
}
keys := make([]string, 0, len(keysRaw))
for _, keyRaw := range keysRaw {
key, ok := keyRaw.(string)
if !ok {
log.Entry().Warnf("%s is needs to be an array of strings", vaultCredentialKeys)
return nil
}
keys = append(keys, key)
}
return keys
}
// ConvertEnvVar converts to a valid environment variable string
func ConvertEnvVar(s string) string {
r := strings.ToUpper(s)
r = strings.ReplaceAll(r, "-", "_")
reg, err := regexp.Compile("[^a-zA-Z0-9_]*")
if err != nil {
log.Entry().Debugf("could not compile regex of convertEnvVar: %v", err)
}
replacedString := reg.ReplaceAllString(r, "")
return replacedString
}
// RemoveVaultSecretFiles removes all secret files that have been created during execution
func RemoveVaultSecretFiles() {
if VaultSecretFileDirectory != "" {
os.RemoveAll(VaultSecretFileDirectory)
}
}
func createTemporarySecretFile(namePattern string, content string) (string, error) {
if VaultSecretFileDirectory == "" {
var err error
fileUtils := &piperutils.Files{}
VaultSecretFileDirectory, err = fileUtils.TempDir("", "vault")
if err != nil {
return "", err
}
}
file, err := os.CreateTemp(VaultSecretFileDirectory, namePattern)
if err != nil {
return "", err
}
defer file.Close()
_, err = file.WriteString(content)
if err != nil {
return "", err
}
return file.Name(), nil
}
func lookupPath(client VaultClient, path string, param *StepParameters) *string {
log.Entry().Debugf(" with Vault path '%s'", path)
secret, err := client.GetKvSecret(path)
if err != nil {
log.Entry().WithError(err).Warnf("Couldn't fetch secret at '%s'", path)
return nil
}
if secret == nil {
return nil
}
field := secret[param.Name]
if field != "" {
log.RegisterSecret(field)
return &field
}
log.Entry().Debugf("Secret did not contain a field name '%s'", param.Name)
// try parameter aliases
for _, alias := range param.Aliases {
log.Entry().Debugf("Trying alias field name '%s'", alias.Name)
field := secret[alias.Name]
if field != "" {
log.RegisterSecret(field)
if alias.Deprecated {
log.Entry().WithField("package", "SAP/jenkins-library/pkg/config").Warningf("DEPRECATION NOTICE: old step config key '%s' used in Vault. Please switch to '%s'!", alias.Name, param.Name)
}
return &field
}
}
return nil
}
func getSecretReferencePaths(reference *ResourceReference, config map[string]interface{}) []string {
retPaths := make([]string, 0, len(VaultRootPaths))
secretName := reference.Default
if providedName, ok := config[reference.Name].(string); ok && providedName != "" {
secretName = providedName
}
for _, rootPath := range VaultRootPaths {
fullPath := path.Join(rootPath, secretName)
retPaths = append(retPaths, fullPath)
}
return retPaths
}
func toStringSlice(interfaceSlice []interface{}) []string {
retSlice := make([]string, 0, len(interfaceSlice))
for _, vRaw := range interfaceSlice {
if v, ok := vRaw.(string); ok {
retSlice = append(retSlice, v)
continue
}
log.Entry().Warnf("'%s' needs to be of type string or an array of strings but got %T (%[2]v)", vaultPath, vRaw)
}
return retSlice
}