/* 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 { BatchGetSecretValueWithContext(aws.Context, *awssm.BatchGetSecretValueInput, ...request.Option) (*awssm.BatchGetSecretValueOutput, error) 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(ctx context.Context, pushSecretRef esv1beta1.PushSecretRemoteRef) (bool, error) { secretName := pushSecretRef.GetRemoteKey() secretValue := awssm.GetSecretValueInput{ SecretId: &secretName, } _, err := sm.client.GetSecretValueWithContext(ctx, &secretValue) if err != nil { return sm.handleSecretError(err) } return true, nil } func (sm *SecretsManager) handleSecretError(err error) (bool, error) { var aerr awserr.Error if ok := errors.As(err, &aerr); !ok { return false, err } if aerr.Code() == awssm.ErrCodeResourceNotFoundException { return false, nil } return false, err } func (sm *SecretsManager) PushSecret(ctx context.Context, secret *corev1.Secret, psd esv1beta1.PushSecretData) error { if psd.GetSecretKey() == "" { return errors.New("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, }, }) return sm.fetchWithBatch(ctx, filters, matcher) } data := make(map[string][]byte) var nextToken *string for { // I put this into the for loop on purpose. log.V(0).Info("using ListSecret to fetch all secrets; this is a costly operations, please use batching by defining a _path_") 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) if err := sm.fetchAndSet(ctx, data, *secret.Name); 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, }, }) } return sm.fetchWithBatch(ctx, filters, 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 errors.New("secret not managed by external-secrets") } if awsSecret != nil && bytes.Equal(awsSecret.SecretBinary, value) || utils.CompareStringAndByteSlices(awsSecret.SecretString, 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 } func (sm *SecretsManager) fetchWithBatch(ctx context.Context, filters []*awssm.Filter, matcher *find.Matcher) (map[string][]byte, error) { data := make(map[string][]byte) var nextToken *string for { it, err := sm.client.BatchGetSecretValueWithContext(ctx, &awssm.BatchGetSecretValueInput{ Filters: filters, NextToken: nextToken, }) metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMBatchGetSecretValue, err) if err != nil { return nil, err } log.V(1).Info("aws sm findByName found", "secrets", len(it.SecretValues)) for _, secret := range it.SecretValues { if matcher != nil && !matcher.MatchName(*secret.Name) { continue } log.V(1).Info("aws sm findByName matches", "name", *secret.Name) sm.setSecretValues(secret, data) } nextToken = it.NextToken if nextToken == nil { break } } return data, nil } func (sm *SecretsManager) setSecretValues(secret *awssm.SecretValueEntry, data map[string][]byte) { if secret.SecretString != nil { data[*secret.Name] = []byte(*secret.SecretString) } if secret.SecretBinary != nil { data[*secret.Name] = secret.SecretBinary } }