-
-
Notifications
You must be signed in to change notification settings - Fork 746
/
secretsmanager.go
597 lines (535 loc) · 17.8 KB
/
secretsmanager.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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package secretsmanager
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"math/big"
"strings"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/aws/session"
awssm "github.com/aws/aws-sdk-go/service/secretsmanager"
"github.com/google/uuid"
"github.com/tidwall/gjson"
"github.com/tidwall/sjson"
corev1 "k8s.io/api/core/v1"
utilpointer "k8s.io/utils/ptr"
ctrl "sigs.k8s.io/controller-runtime"
esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
"github.com/external-secrets/external-secrets/pkg/constants"
"github.com/external-secrets/external-secrets/pkg/find"
"github.com/external-secrets/external-secrets/pkg/metrics"
"github.com/external-secrets/external-secrets/pkg/provider/aws/util"
"github.com/external-secrets/external-secrets/pkg/utils"
)
// Declares metadata information for pushing secrets to AWS Secret Store.
const (
SecretPushFormatKey = "secretPushFormat"
SecretPushFormatString = "string"
SecretPushFormatBinary = "binary"
)
// https://github.com/external-secrets/external-secrets/issues/644
var _ esv1beta1.SecretsClient = &SecretsManager{}
// SecretsManager is a provider for AWS SecretsManager.
type SecretsManager struct {
sess *session.Session
client SMInterface
referentAuth bool
cache map[string]*awssm.GetSecretValueOutput
config *esv1beta1.SecretsManager
}
// SMInterface is a subset of the smiface api.
// see: https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/secretsmanageriface/
type SMInterface interface {
ListSecrets(*awssm.ListSecretsInput) (*awssm.ListSecretsOutput, error)
GetSecretValue(*awssm.GetSecretValueInput) (*awssm.GetSecretValueOutput, error)
CreateSecretWithContext(aws.Context, *awssm.CreateSecretInput, ...request.Option) (*awssm.CreateSecretOutput, error)
GetSecretValueWithContext(aws.Context, *awssm.GetSecretValueInput, ...request.Option) (*awssm.GetSecretValueOutput, error)
PutSecretValueWithContext(aws.Context, *awssm.PutSecretValueInput, ...request.Option) (*awssm.PutSecretValueOutput, error)
DescribeSecretWithContext(aws.Context, *awssm.DescribeSecretInput, ...request.Option) (*awssm.DescribeSecretOutput, error)
DeleteSecretWithContext(ctx aws.Context, input *awssm.DeleteSecretInput, opts ...request.Option) (*awssm.DeleteSecretOutput, error)
}
const (
errUnexpectedFindOperator = "unexpected find operator"
managedBy = "managed-by"
externalSecrets = "external-secrets"
initialVersion = "00000000-0000-0000-0000-000000000001"
)
var log = ctrl.Log.WithName("provider").WithName("aws").WithName("secretsmanager")
// New creates a new SecretsManager client.
func New(sess *session.Session, cfg *aws.Config, secretsManagerCfg *esv1beta1.SecretsManager, referentAuth bool) (*SecretsManager, error) {
return &SecretsManager{
sess: sess,
client: awssm.New(sess, cfg),
referentAuth: referentAuth,
cache: make(map[string]*awssm.GetSecretValueOutput),
config: secretsManagerCfg,
}, nil
}
func (sm *SecretsManager) fetch(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (*awssm.GetSecretValueOutput, error) {
ver := "AWSCURRENT"
valueFrom := "SECRET"
if ref.Version != "" {
ver = ref.Version
}
if ref.MetadataPolicy == esv1beta1.ExternalSecretMetadataPolicyFetch {
valueFrom = "TAG"
}
log.Info("fetching secret value", "key", ref.Key, "version", ver, "value", valueFrom)
cacheKey := fmt.Sprintf("%s#%s#%s", ref.Key, ver, valueFrom)
if secretOut, found := sm.cache[cacheKey]; found {
log.Info("found secret in cache", "key", ref.Key, "version", ver)
return secretOut, nil
}
var secretOut *awssm.GetSecretValueOutput
var err error
if ref.MetadataPolicy == esv1beta1.ExternalSecretMetadataPolicyFetch {
describeSecretInput := &awssm.DescribeSecretInput{
SecretId: &ref.Key,
}
descOutput, err := sm.client.DescribeSecretWithContext(ctx, describeSecretInput)
if err != nil {
return nil, err
}
log.Info("found metadata secret", "key", ref.Key, "output", descOutput)
jsonTags, err := util.SecretTagsToJSONString(descOutput.Tags)
if err != nil {
return nil, err
}
secretOut = &awssm.GetSecretValueOutput{
ARN: descOutput.ARN,
CreatedDate: descOutput.CreatedDate,
Name: descOutput.Name,
SecretString: &jsonTags,
VersionId: &ver,
}
} else {
var getSecretValueInput *awssm.GetSecretValueInput
if strings.HasPrefix(ver, "uuid/") {
versionID := strings.TrimPrefix(ver, "uuid/")
getSecretValueInput = &awssm.GetSecretValueInput{
SecretId: &ref.Key,
VersionId: &versionID,
}
} else {
getSecretValueInput = &awssm.GetSecretValueInput{
SecretId: &ref.Key,
VersionStage: &ver,
}
}
secretOut, err = sm.client.GetSecretValue(getSecretValueInput)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
var nf *awssm.ResourceNotFoundException
if errors.As(err, &nf) {
return nil, esv1beta1.NoSecretErr
}
if err != nil {
return nil, err
}
}
sm.cache[cacheKey] = secretOut
return secretOut, nil
}
func (sm *SecretsManager) DeleteSecret(ctx context.Context, remoteRef esv1beta1.PushSecretRemoteRef) error {
secretName := remoteRef.GetRemoteKey()
secretValue := awssm.GetSecretValueInput{
SecretId: &secretName,
}
secretInput := awssm.DescribeSecretInput{
SecretId: &secretName,
}
awsSecret, err := sm.client.GetSecretValueWithContext(ctx, &secretValue)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
var aerr awserr.Error
if err != nil {
if ok := errors.As(err, &aerr); !ok {
return err
}
if aerr.Code() == awssm.ErrCodeResourceNotFoundException {
return nil
}
return err
}
data, err := sm.client.DescribeSecretWithContext(ctx, &secretInput)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
if err != nil {
return err
}
if !isManagedByESO(data) {
return nil
}
deleteInput := &awssm.DeleteSecretInput{
SecretId: awsSecret.ARN,
}
if sm.config != nil && sm.config.ForceDeleteWithoutRecovery {
deleteInput.ForceDeleteWithoutRecovery = &sm.config.ForceDeleteWithoutRecovery
}
if sm.config != nil && sm.config.RecoveryWindowInDays > 0 {
deleteInput.RecoveryWindowInDays = &sm.config.RecoveryWindowInDays
}
err = util.ValidateDeleteSecretInput(*deleteInput)
if err != nil {
return err
}
_, err = sm.client.DeleteSecretWithContext(ctx, deleteInput)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDeleteSecret, err)
return err
}
func (sm *SecretsManager) SecretExists(_ context.Context, _ esv1beta1.PushSecretRemoteRef) (bool, error) {
return false, fmt.Errorf("not implemented")
}
func (sm *SecretsManager) PushSecret(ctx context.Context, secret *corev1.Secret, psd esv1beta1.PushSecretData) error {
if psd.GetSecretKey() == "" {
return fmt.Errorf("pushing the whole secret is not yet implemented")
}
secretName := psd.GetRemoteKey()
value := secret.Data[psd.GetSecretKey()]
secretValue := awssm.GetSecretValueInput{
SecretId: &secretName,
}
secretInput := awssm.DescribeSecretInput{
SecretId: &secretName,
}
awsSecret, err := sm.client.GetSecretValueWithContext(ctx, &secretValue)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
if psd.GetProperty() != "" {
currentSecret := sm.retrievePayload(awsSecret)
if currentSecret != "" && !gjson.Valid(currentSecret) {
return errors.New("PushSecret for aws secrets manager with a pushSecretData property requires a json secret")
}
value, _ = sjson.SetBytes([]byte(currentSecret), psd.GetProperty(), value)
}
var aerr awserr.Error
if err != nil {
if ok := errors.As(err, &aerr); !ok {
return err
}
if aerr.Code() == awssm.ErrCodeResourceNotFoundException {
return sm.createSecretWithContext(ctx, secretName, psd, value)
}
return err
}
return sm.putSecretValueWithContext(ctx, secretInput, awsSecret, psd, value)
}
func padOrTrim(b []byte) []byte {
l := len(b)
size := 16
if l == size {
return b
}
if l > size {
return b[l-size:]
}
tmp := make([]byte, size)
copy(tmp[size-l:], b)
return tmp
}
func bumpVersionNumber(id *string) (*string, error) {
if id == nil {
output := initialVersion
return &output, nil
}
n := new(big.Int)
oldVersion, ok := n.SetString(strings.ReplaceAll(*id, "-", ""), 16)
if !ok {
return nil, fmt.Errorf("expected secret version in AWS SSM to be a UUID but got '%s'", *id)
}
newVersionRaw := oldVersion.Add(oldVersion, big.NewInt(1)).Bytes()
newVersion, err := uuid.FromBytes(padOrTrim(newVersionRaw))
if err != nil {
return nil, err
}
s := newVersion.String()
return &s, nil
}
func isManagedByESO(data *awssm.DescribeSecretOutput) bool {
managedBy := managedBy
externalSecrets := externalSecrets
for _, tag := range data.Tags {
if *tag.Key == managedBy && *tag.Value == externalSecrets {
return true
}
}
return false
}
// GetAllSecrets syncs multiple secrets from aws provider into a single Kubernetes Secret.
func (sm *SecretsManager) GetAllSecrets(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
if ref.Name != nil {
return sm.findByName(ctx, ref)
}
if len(ref.Tags) > 0 {
return sm.findByTags(ctx, ref)
}
return nil, errors.New(errUnexpectedFindOperator)
}
func (sm *SecretsManager) findByName(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
matcher, err := find.New(*ref.Name)
if err != nil {
return nil, err
}
filters := make([]*awssm.Filter, 0)
if ref.Path != nil {
filters = append(filters, &awssm.Filter{
Key: utilpointer.To(awssm.FilterNameStringTypeName),
Values: []*string{
ref.Path,
},
})
}
data := make(map[string][]byte)
var nextToken *string
for {
it, err := sm.client.ListSecrets(&awssm.ListSecretsInput{
Filters: filters,
NextToken: nextToken,
})
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMListSecrets, err)
if err != nil {
return nil, err
}
log.V(1).Info("aws sm findByName found", "secrets", len(it.SecretList))
for _, secret := range it.SecretList {
if !matcher.MatchName(*secret.Name) {
continue
}
log.V(1).Info("aws sm findByName matches", "name", *secret.Name)
err = sm.fetchAndSet(ctx, data, *secret.Name)
if err != nil {
return nil, err
}
}
nextToken = it.NextToken
if nextToken == nil {
break
}
}
return data, nil
}
func (sm *SecretsManager) findByTags(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
filters := make([]*awssm.Filter, 0)
for k, v := range ref.Tags {
filters = append(filters, &awssm.Filter{
Key: utilpointer.To(awssm.FilterNameStringTypeTagKey),
Values: []*string{
utilpointer.To(k),
},
}, &awssm.Filter{
Key: utilpointer.To(awssm.FilterNameStringTypeTagValue),
Values: []*string{
utilpointer.To(v),
},
})
}
if ref.Path != nil {
filters = append(filters, &awssm.Filter{
Key: utilpointer.To(awssm.FilterNameStringTypeName),
Values: []*string{
ref.Path,
},
})
}
data := make(map[string][]byte)
var nextToken *string
for {
log.V(1).Info("aws sm findByTag", "nextToken", nextToken)
it, err := sm.client.ListSecrets(&awssm.ListSecretsInput{
Filters: filters,
NextToken: nextToken,
})
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMListSecrets, err)
if err != nil {
return nil, err
}
log.V(1).Info("aws sm findByTag found", "secrets", len(it.SecretList))
for _, secret := range it.SecretList {
err = sm.fetchAndSet(ctx, data, *secret.Name)
if err != nil {
return nil, err
}
}
nextToken = it.NextToken
if nextToken == nil {
break
}
}
return data, nil
}
func (sm *SecretsManager) fetchAndSet(ctx context.Context, data map[string][]byte, name string) error {
sec, err := sm.fetch(ctx, esv1beta1.ExternalSecretDataRemoteRef{
Key: name,
})
if err != nil {
return err
}
if sec.SecretString != nil {
data[name] = []byte(*sec.SecretString)
}
if sec.SecretBinary != nil {
data[name] = sec.SecretBinary
}
return nil
}
// GetSecret returns a single secret from the provider.
func (sm *SecretsManager) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
secretOut, err := sm.fetch(ctx, ref)
if errors.Is(err, esv1beta1.NoSecretErr) {
return nil, err
}
if err != nil {
return nil, util.SanitizeErr(err)
}
if ref.Property == "" {
if secretOut.SecretString != nil {
return []byte(*secretOut.SecretString), nil
}
if secretOut.SecretBinary != nil {
return secretOut.SecretBinary, nil
}
return nil, fmt.Errorf("invalid secret received. no secret string nor binary for key: %s", ref.Key)
}
val := sm.mapSecretToGjson(secretOut, ref.Property)
if !val.Exists() {
return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
}
return []byte(val.String()), nil
}
func (sm *SecretsManager) mapSecretToGjson(secretOut *awssm.GetSecretValueOutput, property string) gjson.Result {
payload := sm.retrievePayload(secretOut)
refProperty := sm.escapeDotsIfRequired(property, payload)
val := gjson.Get(payload, refProperty)
return val
}
func (sm *SecretsManager) retrievePayload(secretOut *awssm.GetSecretValueOutput) string {
var payload string
if secretOut.SecretString != nil {
payload = *secretOut.SecretString
}
if secretOut.SecretBinary != nil {
payload = string(secretOut.SecretBinary)
}
return payload
}
func (sm *SecretsManager) escapeDotsIfRequired(currentRefProperty, payload string) string {
// We need to search if a given key with a . exists before using gjson operations.
idx := strings.Index(currentRefProperty, ".")
refProperty := currentRefProperty
if idx > -1 {
refProperty = strings.ReplaceAll(currentRefProperty, ".", "\\.")
val := gjson.Get(payload, refProperty)
if !val.Exists() {
refProperty = currentRefProperty
}
}
return refProperty
}
// GetSecretMap returns multiple k/v pairs from the provider.
func (sm *SecretsManager) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
log.Info("fetching secret map", "key", ref.Key)
data, err := sm.GetSecret(ctx, ref)
if err != nil {
return nil, err
}
kv := make(map[string]json.RawMessage)
err = json.Unmarshal(data, &kv)
if err != nil {
return nil, fmt.Errorf("unable to unmarshal secret %s: %w", ref.Key, err)
}
secretData := make(map[string][]byte)
for k, v := range kv {
var strVal string
err = json.Unmarshal(v, &strVal)
if err == nil {
secretData[k] = []byte(strVal)
} else {
secretData[k] = v
}
}
return secretData, nil
}
func (sm *SecretsManager) Close(_ context.Context) error {
return nil
}
func (sm *SecretsManager) Validate() (esv1beta1.ValidationResult, error) {
// skip validation stack because it depends on the namespace
// of the ExternalSecret
if sm.referentAuth {
return esv1beta1.ValidationResultUnknown, nil
}
_, err := sm.sess.Config.Credentials.Get()
if err != nil {
return esv1beta1.ValidationResultError, util.SanitizeErr(err)
}
return esv1beta1.ValidationResultReady, nil
}
func (sm *SecretsManager) Capabilities() esv1beta1.SecretStoreCapabilities {
return esv1beta1.SecretStoreReadWrite
}
func (sm *SecretsManager) createSecretWithContext(ctx context.Context, secretName string, psd esv1beta1.PushSecretData, value []byte) error {
secretPushFormat, err := utils.FetchValueFromMetadata(SecretPushFormatKey, psd.GetMetadata(), SecretPushFormatBinary)
if err != nil {
return fmt.Errorf("failed to parse metadata: %w", err)
}
input := &awssm.CreateSecretInput{
Name: &secretName,
SecretBinary: value,
Tags: []*awssm.Tag{
{
Key: utilpointer.To(managedBy),
Value: utilpointer.To(externalSecrets),
},
},
ClientRequestToken: utilpointer.To(initialVersion),
}
if secretPushFormat == SecretPushFormatString {
input.SetSecretBinary(nil).SetSecretString(string(value))
}
_, err = sm.client.CreateSecretWithContext(ctx, input)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMCreateSecret, err)
return err
}
func (sm *SecretsManager) putSecretValueWithContext(ctx context.Context, secretInput awssm.DescribeSecretInput, awsSecret *awssm.GetSecretValueOutput, psd esv1beta1.PushSecretData, value []byte) error {
data, err := sm.client.DescribeSecretWithContext(ctx, &secretInput)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
if err != nil {
return err
}
if !isManagedByESO(data) {
return fmt.Errorf("secret not managed by external-secrets")
}
if awsSecret != nil && bytes.Equal(awsSecret.SecretBinary, value) {
return nil
}
newVersionNumber, err := bumpVersionNumber(awsSecret.VersionId)
if err != nil {
return err
}
input := &awssm.PutSecretValueInput{
SecretId: awsSecret.ARN,
SecretBinary: value,
ClientRequestToken: newVersionNumber,
}
secretPushFormat, err := utils.FetchValueFromMetadata(SecretPushFormatKey, psd.GetMetadata(), SecretPushFormatBinary)
if err != nil {
return fmt.Errorf("failed to parse metadata: %w", err)
}
if secretPushFormat == SecretPushFormatString {
input.SetSecretBinary(nil).SetSecretString(string(value))
}
_, err = sm.client.PutSecretValueWithContext(ctx, input)
metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutSecretValue, err)
return err
}