| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967 |
- /*
- Copyright © 2025 ESO Maintainer Team
- 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
- https://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"
- "reflect"
- "slices"
- "strings"
- "github.com/aws/aws-sdk-go-v2/aws"
- awssm "github.com/aws/aws-sdk-go-v2/service/secretsmanager"
- "github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
- "github.com/aws/smithy-go"
- "github.com/google/uuid"
- "github.com/tidwall/gjson"
- "github.com/tidwall/sjson"
- corev1 "k8s.io/api/core/v1"
- apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
- utilpointer "k8s.io/utils/ptr"
- ctrl "sigs.k8s.io/controller-runtime"
- "sigs.k8s.io/controller-runtime/pkg/client"
- esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
- awsutil "github.com/external-secrets/external-secrets/providers/v1/aws/util"
- "github.com/external-secrets/external-secrets/runtime/constants"
- "github.com/external-secrets/external-secrets/runtime/esutils"
- "github.com/external-secrets/external-secrets/runtime/esutils/metadata"
- "github.com/external-secrets/external-secrets/runtime/find"
- "github.com/external-secrets/external-secrets/runtime/metrics"
- )
- // PushSecretMetadataSpec contains metadata information for pushing secrets to AWS Secret Manager.
- type PushSecretMetadataSpec struct {
- Tags map[string]string `json:"tags,omitempty"`
- Description string `json:"description,omitempty"`
- SecretPushFormat string `json:"secretPushFormat,omitempty"`
- KMSKeyID string `json:"kmsKeyId,omitempty"`
- ResourcePolicy *ResourcePolicySpec `json:"resourcePolicy,omitempty"`
- }
- // ResourcePolicySpec defines the resource policy configuration using PolicySourceRef for AWS Secrets Manager.
- type ResourcePolicySpec struct {
- BlockPublicPolicy *bool `json:"blockPublicPolicy,omitempty"`
- PolicySourceRef *PolicySourceRef `json:"policySourceRef,omitempty"`
- }
- // PolicySourceRef defines the source reference for the resource policy.
- type PolicySourceRef struct {
- Kind string `json:"kind"`
- Name string `json:"name"`
- Key string `json:"key"`
- }
- // Declares metadata information for pushing secrets to AWS Secret Store.
- const (
- SecretPushFormatKey = "secretPushFormat"
- SecretPushFormatString = "string"
- SecretPushFormatBinary = "binary"
- ResourceNotFoundException = "ResourceNotFoundException"
- )
- // https://github.com/external-secrets/external-secrets/issues/644
- var _ esv1.SecretsClient = &SecretsManager{}
- // SecretsManager is a provider for AWS SecretsManager.
- type SecretsManager struct {
- cfg *aws.Config
- client SMInterface // Keep the interface
- referentAuth bool
- cache map[string]*awssm.GetSecretValueOutput
- config *esv1.SecretsManager
- prefix string
- newUUID func() string
- kube client.Client
- namespace string
- }
- // SMInterface is a subset of the smiface api.
- // see: https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/secretsmanageriface/
- type SMInterface interface {
- BatchGetSecretValue(ctx context.Context, params *awssm.BatchGetSecretValueInput, optFuncs ...func(*awssm.Options)) (*awssm.BatchGetSecretValueOutput, error)
- ListSecrets(ctx context.Context, params *awssm.ListSecretsInput, optFuncs ...func(*awssm.Options)) (*awssm.ListSecretsOutput, error)
- GetSecretValue(ctx context.Context, params *awssm.GetSecretValueInput, optFuncs ...func(*awssm.Options)) (*awssm.GetSecretValueOutput, error)
- CreateSecret(ctx context.Context, params *awssm.CreateSecretInput, optFuncs ...func(*awssm.Options)) (*awssm.CreateSecretOutput, error)
- PutSecretValue(ctx context.Context, params *awssm.PutSecretValueInput, optFuncs ...func(*awssm.Options)) (*awssm.PutSecretValueOutput, error)
- DescribeSecret(ctx context.Context, params *awssm.DescribeSecretInput, optFuncs ...func(*awssm.Options)) (*awssm.DescribeSecretOutput, error)
- DeleteSecret(ctx context.Context, params *awssm.DeleteSecretInput, optFuncs ...func(*awssm.Options)) (*awssm.DeleteSecretOutput, error)
- TagResource(ctx context.Context, params *awssm.TagResourceInput, optFuncs ...func(*awssm.Options)) (*awssm.TagResourceOutput, error)
- UntagResource(ctx context.Context, params *awssm.UntagResourceInput, optFuncs ...func(*awssm.Options)) (*awssm.UntagResourceOutput, error)
- PutResourcePolicy(ctx context.Context, params *awssm.PutResourcePolicyInput, optFuncs ...func(*awssm.Options)) (*awssm.PutResourcePolicyOutput, error)
- GetResourcePolicy(ctx context.Context, params *awssm.GetResourcePolicyInput, optFuncs ...func(*awssm.Options)) (*awssm.GetResourcePolicyOutput, error)
- DeleteResourcePolicy(ctx context.Context, params *awssm.DeleteResourcePolicyInput, optFuncs ...func(*awssm.Options)) (*awssm.DeleteResourcePolicyOutput, 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(_ context.Context, cfg *aws.Config, secretsManagerCfg *esv1.SecretsManager, prefix string, referentAuth bool, kube client.Client, namespace string) (*SecretsManager, error) {
- return &SecretsManager{
- cfg: cfg,
- client: awssm.NewFromConfig(*cfg, func(o *awssm.Options) {
- o.EndpointResolverV2 = customEndpointResolver{}
- }),
- referentAuth: referentAuth,
- cache: make(map[string]*awssm.GetSecretValueOutput),
- config: secretsManagerCfg,
- prefix: prefix,
- kube: kube,
- namespace: namespace,
- }, nil
- }
- func (sm *SecretsManager) fetch(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (*awssm.GetSecretValueOutput, error) {
- ver := "AWSCURRENT"
- valueFrom := "SECRET"
- if ref.Version != "" {
- ver = ref.Version
- }
- if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
- valueFrom = "TAG"
- }
- key := sm.prefix + ref.Key
- log.Info("fetching secret value", "key", key, "version", ver, "value", valueFrom)
- cacheKey := fmt.Sprintf("%s#%s#%s", key, ver, valueFrom)
- if secretOut, found := sm.cache[cacheKey]; found {
- log.Info("found secret in cache", "key", key, "version", ver)
- return secretOut, nil
- }
- secretOut, err := sm.constructSecretValue(ctx, key, ver, ref.MetadataPolicy)
- if err != nil {
- return nil, err
- }
- sm.cache[cacheKey] = secretOut
- return secretOut, nil
- }
- // DeleteSecret deletes a secret from AWS Secrets Manager.
- func (sm *SecretsManager) DeleteSecret(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) error {
- secretName := sm.prefix + remoteRef.GetRemoteKey()
- secretValue := awssm.GetSecretValueInput{
- SecretId: &secretName,
- }
- secretInput := awssm.DescribeSecretInput{
- SecretId: &secretName,
- }
- awsSecret, err := sm.client.GetSecretValue(ctx, &secretValue)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
- var aerr smithy.APIError
- if err != nil {
- if ok := errors.As(err, &aerr); !ok {
- return err
- }
- if aerr.ErrorCode() == ResourceNotFoundException {
- return nil
- }
- return err
- }
- data, err := sm.client.DescribeSecret(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 = awsutil.ValidateDeleteSecretInput(*deleteInput)
- if err != nil {
- return err
- }
- _, err = sm.client.DeleteSecret(ctx, deleteInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDeleteSecret, err)
- return err
- }
- // SecretExists checks if a secret exists in AWS Secrets Manager.
- func (sm *SecretsManager) SecretExists(ctx context.Context, pushSecretRef esv1.PushSecretRemoteRef) (bool, error) {
- secretName := sm.prefix + pushSecretRef.GetRemoteKey()
- secretValue := awssm.GetSecretValueInput{
- SecretId: &secretName,
- }
- _, err := sm.client.GetSecretValue(ctx, &secretValue)
- if err != nil {
- return sm.handleSecretError(err)
- }
- return true, nil
- }
- func (sm *SecretsManager) handleSecretError(err error) (bool, error) {
- var aerr smithy.APIError
- if ok := errors.As(err, &aerr); !ok {
- return false, err
- }
- if aerr.ErrorCode() == ResourceNotFoundException {
- return false, nil
- }
- return false, err
- }
- // PushSecret pushes a secret to AWS Secrets Manager.
- func (sm *SecretsManager) PushSecret(ctx context.Context, secret *corev1.Secret, psd esv1.PushSecretData) error {
- value, err := esutils.ExtractSecretData(psd, secret)
- if err != nil {
- return fmt.Errorf("failed to extract secret data: %w", err)
- }
- secretName := sm.prefix + psd.GetRemoteKey()
- describeSecretInput := awssm.DescribeSecretInput{SecretId: &secretName}
- describeSecretOutput, err := sm.client.DescribeSecret(ctx, &describeSecretInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
- var aerr smithy.APIError
- if err != nil {
- if ok := errors.As(err, &aerr); !ok {
- return err
- }
- if aerr.ErrorCode() == ResourceNotFoundException {
- finalValue, err := sm.getNewSecretValue(value, psd.GetProperty(), nil)
- if err != nil {
- return err
- }
- return sm.createSecretWithContext(ctx, secretName, psd, finalValue)
- }
- return err
- } else if !isManagedByESO(describeSecretOutput) {
- return errors.New("secret not managed by external-secrets")
- }
- if len(describeSecretOutput.VersionIdsToStages) == 0 {
- finalValue, err := sm.getNewSecretValue(value, psd.GetProperty(), nil)
- if err != nil {
- return err
- }
- return sm.putSecretValueWithContext(ctx, secretName, nil, psd, finalValue, describeSecretOutput.Tags)
- }
- getSecretValueInput := awssm.GetSecretValueInput{SecretId: &secretName}
- getSecretValueOutput, err := sm.client.GetSecretValue(ctx, &getSecretValueInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
- if err != nil {
- return err
- }
- finalValue, err := sm.getNewSecretValue(value, psd.GetProperty(), getSecretValueOutput)
- if err != nil {
- return err
- }
- return sm.putSecretValueWithContext(ctx, secretName, getSecretValueOutput, psd, finalValue, describeSecretOutput.Tags)
- }
- func (sm *SecretsManager) getNewSecretValue(value []byte, property string, existingSecret *awssm.GetSecretValueOutput) ([]byte, error) {
- if property == "" {
- return value, nil
- }
- if existingSecret == nil {
- value, _ = sjson.SetBytes([]byte{}, property, value)
- return value, nil
- }
- currentSecret := sm.retrievePayload(existingSecret)
- if currentSecret != "" && !gjson.Valid(currentSecret) {
- return nil, errors.New("PushSecret for aws secrets manager with a pushSecretData property requires a json secret")
- }
- value, _ = sjson.SetBytes([]byte(currentSecret), property, value)
- return value, 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 esv1.ExternalSecretFind) (map[string][]byte, error) {
- hasName := ref.Name != nil
- hasTags := len(ref.Tags) > 0
- filters := make([]types.Filter, 0)
- switch {
- case !hasName && !hasTags:
- return nil, errors.New(errUnexpectedFindOperator)
- case hasName && !hasTags:
- return sm.findByName(ctx, ref, filters)
- case !hasName && hasTags:
- return sm.findByTags(ctx, ref)
- case hasName && hasTags:
- return sm.findByNameAndTags(ctx, ref, filters)
- default:
- return nil, errors.New(errUnexpectedFindOperator)
- }
- }
- func (sm *SecretsManager) findByNameAndTags(ctx context.Context, ref esv1.ExternalSecretFind, filters []types.Filter) (map[string][]byte, error) {
- for k, v := range ref.Tags {
- filters = append(filters, types.Filter{
- Key: types.FilterNameStringTypeTagKey,
- Values: []string{
- k,
- },
- }, types.Filter{
- Key: types.FilterNameStringTypeTagValue,
- Values: []string{
- v,
- },
- })
- }
- return sm.findByName(ctx, ref, filters)
- }
- func (sm *SecretsManager) findByName(ctx context.Context, ref esv1.ExternalSecretFind, filters []types.Filter) (map[string][]byte, error) {
- matcher, err := find.New(*ref.Name)
- if err != nil {
- return nil, err
- }
- if ref.Path != nil {
- filters = append(filters, types.Filter{
- Key: types.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(ctx, &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 esv1.ExternalSecretFind) (map[string][]byte, error) {
- filters := make([]types.Filter, 0)
- for k, v := range ref.Tags {
- filters = append(filters, types.Filter{
- Key: types.FilterNameStringTypeTagKey,
- Values: []string{
- k,
- },
- }, types.Filter{
- Key: types.FilterNameStringTypeTagValue,
- Values: []string{
- v,
- },
- })
- }
- if ref.Path != nil {
- filters = append(filters, types.Filter{
- Key: types.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, esv1.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 esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
- secretOut, err := sm.fetch(ctx, ref)
- if errors.Is(err, esv1.NoSecretErr) {
- return nil, err
- }
- if err != nil {
- return nil, awsutil.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 {
- if secretOut == nil {
- return ""
- }
- 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 esv1.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
- }
- // Close closes the provider client connection.
- func (sm *SecretsManager) Close(_ context.Context) error {
- return nil
- }
- // Validate validates the provider configuration.
- func (sm *SecretsManager) Validate() (esv1.ValidationResult, error) {
- // skip validation stack because it depends on the namespace
- // of the ExternalSecret
- if sm.referentAuth {
- return esv1.ValidationResultUnknown, nil
- }
- _, err := sm.cfg.Credentials.Retrieve(context.Background())
- if err != nil {
- return esv1.ValidationResultError, awsutil.SanitizeErr(err)
- }
- return esv1.ValidationResultReady, nil
- }
- // Capabilities returns the provider's esv1.SecretStoreCapabilities.
- func (sm *SecretsManager) Capabilities() esv1.SecretStoreCapabilities {
- return esv1.SecretStoreReadWrite
- }
- func (sm *SecretsManager) createSecretWithContext(ctx context.Context, secretName string, psd esv1.PushSecretData, value []byte) error {
- mdata, err := sm.constructMetadataWithDefaults(psd.GetMetadata())
- if err != nil {
- return fmt.Errorf("failed to parse push secret metadata: %w", err)
- }
- tags := make([]types.Tag, 0)
- for k, v := range mdata.Spec.Tags {
- tags = append(tags, types.Tag{
- Key: utilpointer.To(k),
- Value: utilpointer.To(v),
- })
- }
- input := &awssm.CreateSecretInput{
- Name: &secretName,
- SecretBinary: value,
- Tags: tags,
- Description: utilpointer.To(mdata.Spec.Description),
- ClientRequestToken: utilpointer.To(initialVersion),
- KmsKeyId: utilpointer.To(mdata.Spec.KMSKeyID),
- }
- if mdata.Spec.SecretPushFormat == SecretPushFormatString {
- input.SecretBinary = nil
- input.SecretString = aws.String(string(value))
- }
- createOutput, err := sm.client.CreateSecret(ctx, input)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMCreateSecret, err)
- if err != nil {
- return err
- }
- // Apply resource policy if specified
- if mdata.Spec.ResourcePolicy != nil && mdata.Spec.ResourcePolicy.PolicySourceRef != nil {
- policyJSON, err := sm.resolveResourcePolicy(ctx, mdata.Spec.ResourcePolicy.PolicySourceRef)
- if err != nil {
- return fmt.Errorf("failed to resolve resource policy: %w", err)
- }
- putPolicyInput := &awssm.PutResourcePolicyInput{
- SecretId: createOutput.ARN,
- ResourcePolicy: aws.String(policyJSON),
- }
- if mdata.Spec.ResourcePolicy.BlockPublicPolicy != nil {
- putPolicyInput.BlockPublicPolicy = mdata.Spec.ResourcePolicy.BlockPublicPolicy
- }
- _, err = sm.client.PutResourcePolicy(ctx, putPolicyInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutResourcePolicy, err)
- if err != nil {
- return fmt.Errorf("failed to put resource policy: %w", err)
- }
- }
- return nil
- }
- func (sm *SecretsManager) putSecretValueWithContext(ctx context.Context, secretArn string, awsSecret *awssm.GetSecretValueOutput, psd esv1.PushSecretData, value []byte, tags []types.Tag) error {
- if awsSecret != nil && (bytes.Equal(awsSecret.SecretBinary, value) || esutils.CompareStringAndByteSlices(awsSecret.SecretString, value)) {
- return nil
- }
- newVersionNumber := initialVersion
- if awsSecret != nil {
- if sm.newUUID == nil {
- newVersionNumber = uuid.NewString()
- } else {
- newVersionNumber = sm.newUUID()
- }
- }
- input := &awssm.PutSecretValueInput{
- SecretId: &secretArn,
- SecretBinary: value,
- ClientRequestToken: aws.String(newVersionNumber),
- }
- secretPushFormat, err := esutils.FetchValueFromMetadata(SecretPushFormatKey, psd.GetMetadata(), SecretPushFormatBinary)
- if err != nil {
- return fmt.Errorf("failed to parse metadata: %w", err)
- }
- if secretPushFormat == SecretPushFormatString {
- input.SecretBinary = nil
- input.SecretString = aws.String(string(value))
- }
- _, err = sm.client.PutSecretValue(ctx, input)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutSecretValue, err)
- if err != nil {
- return err
- }
- currentTags := make(map[string]string, len(tags))
- for _, tag := range tags {
- currentTags[*tag.Key] = *tag.Value
- }
- if err := sm.patchTags(ctx, psd.GetMetadata(), &secretArn, currentTags); err != nil {
- return err
- }
- // Manage resource policy if specified in metadata
- return sm.manageResourcePolicy(ctx, psd.GetMetadata(), &secretArn)
- }
- func (sm *SecretsManager) patchTags(ctx context.Context, metadata *apiextensionsv1.JSON, secretID *string, tags map[string]string) error {
- meta, err := sm.constructMetadataWithDefaults(metadata)
- if err != nil {
- return err
- }
- tagKeysToRemove := awsutil.FindTagKeysToRemove(tags, meta.Spec.Tags)
- if len(tagKeysToRemove) > 0 {
- _, err = sm.client.UntagResource(ctx, &awssm.UntagResourceInput{
- SecretId: secretID,
- TagKeys: tagKeysToRemove,
- })
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMUntagResource, err)
- if err != nil {
- return err
- }
- }
- tagsToUpdate, isModified := computeTagsToUpdate(tags, meta.Spec.Tags)
- if isModified {
- _, err = sm.client.TagResource(ctx, &awssm.TagResourceInput{
- SecretId: secretID,
- Tags: tagsToUpdate,
- })
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMTagResource, err)
- if err != nil {
- return err
- }
- }
- return nil
- }
- func (sm *SecretsManager) fetchWithBatch(ctx context.Context, filters []types.Filter, matcher *find.Matcher) (map[string][]byte, error) {
- data := make(map[string][]byte)
- var nextToken *string
- for {
- it, err := sm.client.BatchGetSecretValue(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 *types.SecretValueEntry, data map[string][]byte) {
- if secret.SecretString != nil {
- data[*secret.Name] = []byte(*secret.SecretString)
- }
- if secret.SecretBinary != nil {
- data[*secret.Name] = secret.SecretBinary
- }
- }
- func (sm *SecretsManager) constructSecretValue(ctx context.Context, key, ver string, metadataPolicy esv1.ExternalSecretMetadataPolicy) (*awssm.GetSecretValueOutput, error) {
- if metadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
- describeSecretInput := &awssm.DescribeSecretInput{
- SecretId: &key,
- }
- descOutput, err := sm.client.DescribeSecret(ctx, describeSecretInput)
- if err != nil {
- return nil, err
- }
- log.Info("found metadata secret", "key", key, "output", descOutput)
- jsonTags, err := awsutil.SecretTagsToJSONString(descOutput.Tags)
- if err != nil {
- return nil, err
- }
- return &awssm.GetSecretValueOutput{
- ARN: descOutput.ARN,
- CreatedDate: descOutput.CreatedDate,
- Name: descOutput.Name,
- SecretString: &jsonTags,
- VersionId: &ver,
- }, nil
- }
- var getSecretValueInput *awssm.GetSecretValueInput
- if strings.HasPrefix(ver, "uuid/") {
- versionID := strings.TrimPrefix(ver, "uuid/")
- getSecretValueInput = &awssm.GetSecretValueInput{
- SecretId: &key,
- VersionId: &versionID,
- }
- } else {
- getSecretValueInput = &awssm.GetSecretValueInput{
- SecretId: &key,
- VersionStage: &ver,
- }
- }
- secretOut, err := sm.client.GetSecretValue(ctx, getSecretValueInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
- var (
- nf *types.ResourceNotFoundException
- ie *types.InvalidParameterException
- )
- if errors.As(err, &nf) {
- return nil, esv1.NoSecretErr
- }
- if errors.As(err, &ie) && strings.Contains(ie.Error(), "was marked for deletion") {
- return nil, esv1.NoSecretErr
- }
- return secretOut, err
- }
- func (sm *SecretsManager) constructMetadataWithDefaults(data *apiextensionsv1.JSON) (*metadata.PushSecretMetadata[PushSecretMetadataSpec], error) {
- var (
- meta *metadata.PushSecretMetadata[PushSecretMetadataSpec]
- err error
- )
- meta, err = metadata.ParseMetadataParameters[PushSecretMetadataSpec](data)
- if err != nil {
- return nil, fmt.Errorf("failed to parse metadata: %w", err)
- }
- if meta == nil {
- meta = &metadata.PushSecretMetadata[PushSecretMetadataSpec]{}
- }
- if meta.Spec.SecretPushFormat == "" {
- meta.Spec.SecretPushFormat = SecretPushFormatBinary
- } else if !slices.Contains([]string{SecretPushFormatBinary, SecretPushFormatString}, meta.Spec.SecretPushFormat) {
- return nil, fmt.Errorf("invalid secret push format: %s", meta.Spec.SecretPushFormat)
- }
- if meta.Spec.Description == "" {
- meta.Spec.Description = fmt.Sprintf("secret '%s:%s'", managedBy, externalSecrets)
- }
- if meta.Spec.KMSKeyID == "" {
- meta.Spec.KMSKeyID = "alias/aws/secretsmanager"
- }
- if len(meta.Spec.Tags) > 0 {
- if _, exists := meta.Spec.Tags[managedBy]; exists {
- return nil, fmt.Errorf("error parsing tags in metadata: Cannot specify a '%s' tag", managedBy)
- }
- } else {
- meta.Spec.Tags = make(map[string]string)
- }
- meta.Spec.Tags[managedBy] = externalSecrets
- return meta, nil
- }
- // resolveResourcePolicy resolves the policy JSON from the PolicySourceRef.
- func (sm *SecretsManager) resolveResourcePolicy(ctx context.Context, policyRef *PolicySourceRef) (string, error) {
- if policyRef == nil {
- return "", errors.New("policySourceRef is nil")
- }
- switch policyRef.Kind {
- case "ConfigMap":
- cm := &corev1.ConfigMap{}
- if err := sm.kube.Get(ctx, client.ObjectKey{
- Namespace: sm.namespace,
- Name: policyRef.Name,
- }, cm); err != nil {
- return "", fmt.Errorf("failed to get ConfigMap %s/%s: %w", sm.namespace, policyRef.Name, err)
- }
- policy, ok := cm.Data[policyRef.Key]
- if !ok {
- return "", fmt.Errorf("key %s not found in ConfigMap %s/%s", policyRef.Key, sm.namespace, policyRef.Name)
- }
- return policy, nil
- case "Secret":
- secret := &corev1.Secret{}
- if err := sm.kube.Get(ctx, client.ObjectKey{
- Namespace: sm.namespace,
- Name: policyRef.Name,
- }, secret); err != nil {
- return "", fmt.Errorf("failed to get Secret %s/%s: %w", sm.namespace, policyRef.Name, err)
- }
- policyBytes, ok := secret.Data[policyRef.Key]
- if !ok {
- return "", fmt.Errorf("key %s not found in Secret %s/%s", policyRef.Key, sm.namespace, policyRef.Name)
- }
- return string(policyBytes), nil
- default:
- return "", fmt.Errorf("unsupported PolicySourceRef kind: %s (must be ConfigMap or Secret)", policyRef.Kind)
- }
- }
- // manageResourcePolicy applies or removes the resource policy based on metadata.
- func (sm *SecretsManager) manageResourcePolicy(ctx context.Context, metadata *apiextensionsv1.JSON, secretID *string) error {
- meta, err := sm.constructMetadataWithDefaults(metadata)
- if err != nil {
- return err
- }
- // Delete policy if policyRef is nil and the policy exists.
- if meta.Spec.ResourcePolicy == nil {
- deletePolicyInput := &awssm.DeleteResourcePolicyInput{
- SecretId: secretID,
- }
- _, err = sm.client.DeleteResourcePolicy(ctx, deletePolicyInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDeleteResourcePolicy, err)
- var nf *types.ResourceNotFoundException
- if err != nil && !errors.As(err, &nf) {
- return fmt.Errorf("failed to delete resource policy: %w", err)
- }
- return nil
- }
- // Normal flow, is to create the policy.
- policyJSON, err := sm.resolveResourcePolicy(ctx, meta.Spec.ResourcePolicy.PolicySourceRef)
- if err != nil {
- return fmt.Errorf("failed to resolve resource policy: %w", err)
- }
- getCurrentPolicyInput := &awssm.GetResourcePolicyInput{
- SecretId: secretID,
- }
- currentPolicyOutput, err := sm.client.GetResourcePolicy(ctx, getCurrentPolicyInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetResourcePolicy, err)
- var nf *types.ResourceNotFoundException
- if err != nil && !errors.As(err, &nf) {
- return fmt.Errorf("failed to get current resource policy: %w", err)
- }
- currentPolicy := ""
- if currentPolicyOutput != nil && currentPolicyOutput.ResourcePolicy != nil {
- currentPolicy = *currentPolicyOutput.ResourcePolicy
- }
- // convert to maps so we can do a stable comparison.
- var (
- currentPolicyMap map[string]any
- policyJSONMaps map[string]any
- )
- if err := json.Unmarshal([]byte(currentPolicy), ¤tPolicyMap); err != nil {
- return fmt.Errorf("failed to unmarshal current resource policy: %w", err)
- }
- if err := json.Unmarshal([]byte(policyJSON), &policyJSONMaps); err != nil {
- return fmt.Errorf("failed to unmarshal current resource policy: %w", err)
- }
- if reflect.DeepEqual(currentPolicyMap, policyJSONMaps) {
- return nil
- }
- putPolicyInput := &awssm.PutResourcePolicyInput{
- SecretId: secretID,
- ResourcePolicy: aws.String(policyJSON),
- }
- if meta.Spec.ResourcePolicy.BlockPublicPolicy != nil {
- putPolicyInput.BlockPublicPolicy = meta.Spec.ResourcePolicy.BlockPublicPolicy
- }
- _, err = sm.client.PutResourcePolicy(ctx, putPolicyInput)
- metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutResourcePolicy, err)
- if err != nil {
- return fmt.Errorf("failed to put resource policy: %w", err)
- }
- return nil
- }
- // computeTagsToUpdate compares the current tags with the desired metaTags and returns a slice of ssmTypes.Tag
- // that should be set on the resource. It also returns a boolean indicating if any tag was added or modified.
- func computeTagsToUpdate(tags, metaTags map[string]string) ([]types.Tag, bool) {
- result := make([]types.Tag, 0, len(metaTags))
- modified := false
- for k, v := range metaTags {
- if _, exists := tags[k]; !exists || tags[k] != v {
- if k != managedBy {
- modified = true
- }
- }
- result = append(result, types.Tag{
- Key: utilpointer.To(k),
- Value: utilpointer.To(v),
- })
- }
- return result, modified
- }
|