-
-
Notifications
You must be signed in to change notification settings - Fork 773
/
parameterstore.go
523 lines (469 loc) · 16.3 KB
/
parameterstore.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
/*
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 parameterstore
import (
"context"
"encoding/json"
"errors"
"fmt"
"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"
"github.com/aws/aws-sdk-go/service/ssm"
"github.com/tidwall/gjson"
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"
)
// https://github.com/external-secrets/external-secrets/issues/644
var (
_ esv1beta1.SecretsClient = &ParameterStore{}
managedBy = "managed-by"
externalSecrets = "external-secrets"
logger = ctrl.Log.WithName("provider").WithName("parameterstore")
)
// ParameterStore is a provider for AWS ParameterStore.
type ParameterStore struct {
sess *session.Session
client PMInterface
referentAuth bool
}
// PMInterface is a subset of the parameterstore api.
// see: https://docs.aws.amazon.com/sdk-for-go/api/service/ssm/ssmiface/
type PMInterface interface {
GetParameterWithContext(aws.Context, *ssm.GetParameterInput, ...request.Option) (*ssm.GetParameterOutput, error)
GetParametersByPathWithContext(aws.Context, *ssm.GetParametersByPathInput, ...request.Option) (*ssm.GetParametersByPathOutput, error)
PutParameterWithContext(aws.Context, *ssm.PutParameterInput, ...request.Option) (*ssm.PutParameterOutput, error)
DescribeParametersWithContext(aws.Context, *ssm.DescribeParametersInput, ...request.Option) (*ssm.DescribeParametersOutput, error)
ListTagsForResourceWithContext(aws.Context, *ssm.ListTagsForResourceInput, ...request.Option) (*ssm.ListTagsForResourceOutput, error)
DeleteParameterWithContext(ctx aws.Context, input *ssm.DeleteParameterInput, opts ...request.Option) (*ssm.DeleteParameterOutput, error)
}
const (
errUnexpectedFindOperator = "unexpected find operator"
errAccessDeniedException = "AccessDeniedException"
)
// New constructs a ParameterStore Provider that is specific to a store.
func New(sess *session.Session, cfg *aws.Config, referentAuth bool) (*ParameterStore, error) {
return &ParameterStore{
sess: sess,
referentAuth: referentAuth,
client: ssm.New(sess, cfg),
}, nil
}
func (pm *ParameterStore) getTagsByName(ctx aws.Context, ref *ssm.GetParameterOutput) ([]*ssm.Tag, error) {
parameterType := "Parameter"
parameterTags := ssm.ListTagsForResourceInput{
ResourceId: ref.Parameter.Name,
ResourceType: ¶meterType,
}
data, err := pm.client.ListTagsForResourceWithContext(ctx, ¶meterTags)
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSListTagsForResource, err)
if err != nil {
return nil, fmt.Errorf("error listing tags %w", err)
}
return data.TagList, nil
}
func (pm *ParameterStore) DeleteSecret(ctx context.Context, remoteRef esv1beta1.PushSecretRemoteRef) error {
secretName := remoteRef.GetRemoteKey()
secretValue := ssm.GetParameterInput{
Name: &secretName,
}
existing, err := pm.client.GetParameterWithContext(ctx, &secretValue)
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSGetParameter, err)
var awsError awserr.Error
ok := errors.As(err, &awsError)
if err != nil && (!ok || awsError.Code() != ssm.ErrCodeParameterNotFound) {
return fmt.Errorf("unexpected error getting parameter %v: %w", secretName, err)
}
if existing != nil && existing.Parameter != nil {
fmt.Println("The existing value contains data:", existing.String())
tags, err := pm.getTagsByName(ctx, existing)
if err != nil {
return fmt.Errorf("error getting the existing tags for the parameter %v: %w", secretName, err)
}
isManaged := isManagedByESO(tags)
if !isManaged {
// If the secret is not managed by external-secrets, it is "deleted" effectively by all means
return nil
}
deleteInput := &ssm.DeleteParameterInput{
Name: &secretName,
}
_, err = pm.client.DeleteParameterWithContext(ctx, deleteInput)
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSDeleteParameter, err)
if err != nil {
return fmt.Errorf("could not delete parameter %v: %w", secretName, err)
}
}
return nil
}
func (pm *ParameterStore) SecretExists(_ context.Context, _ esv1beta1.PushSecretRemoteRef) (bool, error) {
return false, fmt.Errorf("not implemented")
}
func (pm *ParameterStore) PushSecret(ctx context.Context, secret *corev1.Secret, data esv1beta1.PushSecretData) error {
parameterType := "String"
overwrite := true
var (
value []byte
err error
)
key := data.GetSecretKey()
if key == "" {
value, err = utils.JSONMarshal(secret.Data)
if err != nil {
return fmt.Errorf("failed to serialize secret content as JSON: %w", err)
}
} else {
value = secret.Data[key]
}
stringValue := string(value)
secretName := data.GetRemoteKey()
secretRequest := ssm.PutParameterInput{
Name: &secretName,
Value: &stringValue,
Type: ¶meterType,
Overwrite: &overwrite,
}
secretValue := ssm.GetParameterInput{
Name: &secretName,
}
existing, err := pm.client.GetParameterWithContext(ctx, &secretValue)
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSGetParameter, err)
var awsError awserr.Error
ok := errors.As(err, &awsError)
if err != nil && (!ok || awsError.Code() != ssm.ErrCodeParameterNotFound) {
return fmt.Errorf("unexpected error getting parameter %v: %w", secretName, err)
}
// If we have a valid parameter returned to us, check its tags
if existing != nil && existing.Parameter != nil {
fmt.Println("The existing value contains data:", existing.String())
tags, err := pm.getTagsByName(ctx, existing)
if err != nil {
return fmt.Errorf("error getting the existing tags for the parameter %v: %w", secretName, err)
}
isManaged := isManagedByESO(tags)
if !isManaged {
return fmt.Errorf("secret not managed by external-secrets")
}
if existing.Parameter.Value != nil && *existing.Parameter.Value == string(value) {
return nil
}
return pm.setManagedRemoteParameter(ctx, secretRequest, false)
}
// let's set the secret
// Do we need to delete the existing parameter on the remote?
return pm.setManagedRemoteParameter(ctx, secretRequest, true)
}
func isManagedByESO(tags []*ssm.Tag) bool {
for _, tag := range tags {
if *tag.Key == managedBy && *tag.Value == externalSecrets {
return true
}
}
return false
}
func (pm *ParameterStore) setManagedRemoteParameter(ctx context.Context, secretRequest ssm.PutParameterInput, createManagedByTags bool) error {
externalSecretsTag := ssm.Tag{
Key: &managedBy,
Value: &externalSecrets,
}
overwrite := true
secretRequest.Overwrite = &overwrite
if createManagedByTags {
secretRequest.Tags = append(secretRequest.Tags, &externalSecretsTag)
overwrite = false
}
_, err := pm.client.PutParameterWithContext(ctx, &secretRequest)
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSPutParameter, err)
if err != nil {
return fmt.Errorf("unexpected error pushing parameter %v: %w", secretRequest.Name, err)
}
return nil
}
// GetAllSecrets fetches information from multiple secrets into a single kubernetes secret.
func (pm *ParameterStore) GetAllSecrets(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
if ref.Name != nil {
return pm.findByName(ctx, ref)
}
if ref.Tags != nil {
return pm.findByTags(ctx, ref)
}
return nil, errors.New(errUnexpectedFindOperator)
}
// findByName requires `ssm:GetParametersByPath` IAM permission, but the `Resource` scope can be limited.
func (pm *ParameterStore) findByName(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
matcher, err := find.New(*ref.Name)
if err != nil {
return nil, err
}
if ref.Path == nil {
ref.Path = aws.String("/")
}
data := make(map[string][]byte)
var nextToken *string
for {
it, err := pm.client.GetParametersByPathWithContext(
ctx,
&ssm.GetParametersByPathInput{
NextToken: nextToken,
Path: ref.Path,
Recursive: aws.Bool(true),
WithDecryption: aws.Bool(true),
})
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSGetParametersByPath, err)
if err != nil {
/*
Check for AccessDeniedException when calling `GetParametersByPathWithContext`. If so,
use fallbackFindByName and `DescribeParametersWithContext`.
https://github.com/external-secrets/external-secrets/issues/1839#issuecomment-1489023522
*/
var awsError awserr.Error
if errors.As(err, &awsError) && awsError.Code() == errAccessDeniedException {
logger.Info("GetParametersByPath: access denied. using fallback to describe parameters. It is recommended to add ssm:GetParametersByPath permissions", "path", ref.Path)
return pm.fallbackFindByName(ctx, ref)
}
return nil, err
}
for _, param := range it.Parameters {
if !matcher.MatchName(*param.Name) {
continue
}
err = pm.fetchAndSet(ctx, data, *param.Name)
if err != nil {
return nil, err
}
}
nextToken = it.NextToken
if nextToken == nil {
break
}
}
return data, nil
}
// fallbackFindByName requires `ssm:DescribeParameters` IAM permission on `"Resource": "*"`.
func (pm *ParameterStore) fallbackFindByName(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
matcher, err := find.New(*ref.Name)
if err != nil {
return nil, err
}
pathFilter := make([]*ssm.ParameterStringFilter, 0)
if ref.Path != nil {
pathFilter = append(pathFilter, &ssm.ParameterStringFilter{
Key: aws.String("Path"),
Option: aws.String("Recursive"),
Values: []*string{ref.Path},
})
}
data := make(map[string][]byte)
var nextToken *string
for {
it, err := pm.client.DescribeParametersWithContext(
ctx,
&ssm.DescribeParametersInput{
NextToken: nextToken,
ParameterFilters: pathFilter,
})
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSDescribeParameter, err)
if err != nil {
return nil, err
}
for _, param := range it.Parameters {
if !matcher.MatchName(*param.Name) {
continue
}
err = pm.fetchAndSet(ctx, data, *param.Name)
if err != nil {
return nil, err
}
}
nextToken = it.NextToken
if nextToken == nil {
break
}
}
return data, nil
}
// findByTags requires ssm:DescribeParameters,tag:GetResources IAM permission on `"Resource": "*"`.
func (pm *ParameterStore) findByTags(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
filters := make([]*ssm.ParameterStringFilter, 0)
for k, v := range ref.Tags {
filters = append(filters, &ssm.ParameterStringFilter{
Key: utilpointer.To(fmt.Sprintf("tag:%s", k)),
Values: []*string{utilpointer.To(v)},
Option: utilpointer.To("Equals"),
})
}
if ref.Path != nil {
filters = append(filters, &ssm.ParameterStringFilter{
Key: aws.String("Path"),
Option: aws.String("Recursive"),
Values: []*string{ref.Path},
})
}
data := make(map[string][]byte)
var nextToken *string
for {
it, err := pm.client.DescribeParametersWithContext(
ctx,
&ssm.DescribeParametersInput{
ParameterFilters: filters,
NextToken: nextToken,
})
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSDescribeParameter, err)
if err != nil {
return nil, err
}
for _, param := range it.Parameters {
err = pm.fetchAndSet(ctx, data, *param.Name)
if err != nil {
return nil, err
}
}
nextToken = it.NextToken
if nextToken == nil {
break
}
}
return data, nil
}
func (pm *ParameterStore) fetchAndSet(ctx context.Context, data map[string][]byte, name string) error {
out, err := pm.client.GetParameterWithContext(ctx, &ssm.GetParameterInput{
Name: utilpointer.To(name),
WithDecryption: aws.Bool(true),
})
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSGetParameter, err)
if err != nil {
return util.SanitizeErr(err)
}
data[name] = []byte(*out.Parameter.Value)
return nil
}
// GetSecret returns a single secret from the provider.
func (pm *ParameterStore) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
var out *ssm.GetParameterOutput
var err error
if ref.MetadataPolicy == esv1beta1.ExternalSecretMetadataPolicyFetch {
out, err = pm.getParameterTags(ctx, ref)
} else {
out, err = pm.getParameterValue(ctx, ref)
}
metrics.ObserveAPICall(constants.ProviderAWSPS, constants.CallAWSPSGetParameter, err)
nsf := esv1beta1.NoSecretError{}
var nf *ssm.ParameterNotFound
if errors.As(err, &nf) || errors.As(err, &nsf) {
return nil, esv1beta1.NoSecretErr
}
if err != nil {
return nil, util.SanitizeErr(err)
}
if ref.Property == "" {
if out.Parameter.Value != nil {
return []byte(*out.Parameter.Value), nil
}
return nil, fmt.Errorf("invalid secret received. parameter value is nil for key: %s", ref.Key)
}
idx := strings.Index(ref.Property, ".")
if idx > -1 {
refProperty := strings.ReplaceAll(ref.Property, ".", "\\.")
val := gjson.Get(*out.Parameter.Value, refProperty)
if val.Exists() {
return []byte(val.String()), nil
}
}
val := gjson.Get(*out.Parameter.Value, 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 (pm *ParameterStore) getParameterTags(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (*ssm.GetParameterOutput, error) {
param := ssm.GetParameterOutput{
Parameter: &ssm.Parameter{
Name: parameterNameWithVersion(ref),
},
}
tags, err := pm.getTagsByName(ctx, ¶m)
if err != nil {
return nil, err
}
json, err := util.ParameterTagsToJSONString(tags)
if err != nil {
return nil, err
}
out := &ssm.GetParameterOutput{
Parameter: &ssm.Parameter{
Value: &json,
},
}
return out, nil
}
func (pm *ParameterStore) getParameterValue(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (*ssm.GetParameterOutput, error) {
out, err := pm.client.GetParameterWithContext(ctx, &ssm.GetParameterInput{
Name: parameterNameWithVersion(ref),
WithDecryption: aws.Bool(true),
})
return out, err
}
// GetSecretMap returns multiple k/v pairs from the provider.
func (pm *ParameterStore) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
data, err := pm.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 parameterNameWithVersion(ref esv1beta1.ExternalSecretDataRemoteRef) *string {
name := ref.Key
if ref.Version != "" {
// see docs: https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-versions.html#reference-parameter-version
name += ":" + ref.Version
}
return &name
}
func (pm *ParameterStore) Close(_ context.Context) error {
return nil
}
func (pm *ParameterStore) Validate() (esv1beta1.ValidationResult, error) {
// skip validation stack because it depends on the namespace
// of the ExternalSecret
if pm.referentAuth {
return esv1beta1.ValidationResultUnknown, nil
}
_, err := pm.sess.Config.Credentials.Get()
if err != nil {
return esv1beta1.ValidationResultError, err
}
return esv1beta1.ValidationResultReady, nil
}