secretsmanager.go 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package secretsmanager
  14. import (
  15. "bytes"
  16. "context"
  17. "encoding/json"
  18. "errors"
  19. "fmt"
  20. "reflect"
  21. "slices"
  22. "strings"
  23. "github.com/aws/aws-sdk-go-v2/aws"
  24. awssm "github.com/aws/aws-sdk-go-v2/service/secretsmanager"
  25. "github.com/aws/aws-sdk-go-v2/service/secretsmanager/types"
  26. "github.com/aws/smithy-go"
  27. "github.com/google/uuid"
  28. "github.com/tidwall/gjson"
  29. "github.com/tidwall/sjson"
  30. corev1 "k8s.io/api/core/v1"
  31. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  32. utilpointer "k8s.io/utils/ptr"
  33. ctrl "sigs.k8s.io/controller-runtime"
  34. "sigs.k8s.io/controller-runtime/pkg/client"
  35. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  36. awsutil "github.com/external-secrets/external-secrets/providers/v1/aws/util"
  37. "github.com/external-secrets/external-secrets/runtime/constants"
  38. "github.com/external-secrets/external-secrets/runtime/esutils"
  39. "github.com/external-secrets/external-secrets/runtime/esutils/metadata"
  40. "github.com/external-secrets/external-secrets/runtime/find"
  41. "github.com/external-secrets/external-secrets/runtime/metrics"
  42. )
  43. // PushSecretMetadataSpec contains metadata information for pushing secrets to AWS Secret Manager.
  44. type PushSecretMetadataSpec struct {
  45. Tags map[string]string `json:"tags,omitempty"`
  46. Description string `json:"description,omitempty"`
  47. SecretPushFormat string `json:"secretPushFormat,omitempty"`
  48. KMSKeyID string `json:"kmsKeyId,omitempty"`
  49. ResourcePolicy *ResourcePolicySpec `json:"resourcePolicy,omitempty"`
  50. }
  51. // ResourcePolicySpec defines the resource policy configuration using PolicySourceRef for AWS Secrets Manager.
  52. type ResourcePolicySpec struct {
  53. BlockPublicPolicy *bool `json:"blockPublicPolicy,omitempty"`
  54. PolicySourceRef *PolicySourceRef `json:"policySourceRef,omitempty"`
  55. }
  56. // PolicySourceRef defines the source reference for the resource policy.
  57. type PolicySourceRef struct {
  58. Kind string `json:"kind"`
  59. Name string `json:"name"`
  60. Key string `json:"key"`
  61. }
  62. // Declares metadata information for pushing secrets to AWS Secret Store.
  63. const (
  64. SecretPushFormatKey = "secretPushFormat"
  65. SecretPushFormatString = "string"
  66. SecretPushFormatBinary = "binary"
  67. ResourceNotFoundException = "ResourceNotFoundException"
  68. )
  69. // https://github.com/external-secrets/external-secrets/issues/644
  70. var _ esv1.SecretsClient = &SecretsManager{}
  71. // SecretsManager is a provider for AWS SecretsManager.
  72. type SecretsManager struct {
  73. cfg *aws.Config
  74. client SMInterface // Keep the interface
  75. referentAuth bool
  76. cache map[string]*awssm.GetSecretValueOutput
  77. config *esv1.SecretsManager
  78. prefix string
  79. newUUID func() string
  80. kube client.Client
  81. namespace string
  82. }
  83. // SMInterface is a subset of the smiface api.
  84. // see: https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/secretsmanageriface/
  85. type SMInterface interface {
  86. BatchGetSecretValue(ctx context.Context, params *awssm.BatchGetSecretValueInput, optFuncs ...func(*awssm.Options)) (*awssm.BatchGetSecretValueOutput, error)
  87. ListSecrets(ctx context.Context, params *awssm.ListSecretsInput, optFuncs ...func(*awssm.Options)) (*awssm.ListSecretsOutput, error)
  88. GetSecretValue(ctx context.Context, params *awssm.GetSecretValueInput, optFuncs ...func(*awssm.Options)) (*awssm.GetSecretValueOutput, error)
  89. CreateSecret(ctx context.Context, params *awssm.CreateSecretInput, optFuncs ...func(*awssm.Options)) (*awssm.CreateSecretOutput, error)
  90. PutSecretValue(ctx context.Context, params *awssm.PutSecretValueInput, optFuncs ...func(*awssm.Options)) (*awssm.PutSecretValueOutput, error)
  91. DescribeSecret(ctx context.Context, params *awssm.DescribeSecretInput, optFuncs ...func(*awssm.Options)) (*awssm.DescribeSecretOutput, error)
  92. DeleteSecret(ctx context.Context, params *awssm.DeleteSecretInput, optFuncs ...func(*awssm.Options)) (*awssm.DeleteSecretOutput, error)
  93. TagResource(ctx context.Context, params *awssm.TagResourceInput, optFuncs ...func(*awssm.Options)) (*awssm.TagResourceOutput, error)
  94. UntagResource(ctx context.Context, params *awssm.UntagResourceInput, optFuncs ...func(*awssm.Options)) (*awssm.UntagResourceOutput, error)
  95. PutResourcePolicy(ctx context.Context, params *awssm.PutResourcePolicyInput, optFuncs ...func(*awssm.Options)) (*awssm.PutResourcePolicyOutput, error)
  96. GetResourcePolicy(ctx context.Context, params *awssm.GetResourcePolicyInput, optFuncs ...func(*awssm.Options)) (*awssm.GetResourcePolicyOutput, error)
  97. DeleteResourcePolicy(ctx context.Context, params *awssm.DeleteResourcePolicyInput, optFuncs ...func(*awssm.Options)) (*awssm.DeleteResourcePolicyOutput, error)
  98. }
  99. const (
  100. errUnexpectedFindOperator = "unexpected find operator"
  101. managedBy = "managed-by"
  102. externalSecrets = "external-secrets"
  103. initialVersion = "00000000-0000-0000-0000-000000000001"
  104. )
  105. var log = ctrl.Log.WithName("provider").WithName("aws").WithName("secretsmanager")
  106. // New creates a new SecretsManager client.
  107. func New(_ context.Context, cfg *aws.Config, secretsManagerCfg *esv1.SecretsManager, prefix string, referentAuth bool, kube client.Client, namespace string) (*SecretsManager, error) {
  108. return &SecretsManager{
  109. cfg: cfg,
  110. client: awssm.NewFromConfig(*cfg, func(o *awssm.Options) {
  111. o.EndpointResolverV2 = customEndpointResolver{}
  112. }),
  113. referentAuth: referentAuth,
  114. cache: make(map[string]*awssm.GetSecretValueOutput),
  115. config: secretsManagerCfg,
  116. prefix: prefix,
  117. kube: kube,
  118. namespace: namespace,
  119. }, nil
  120. }
  121. func (sm *SecretsManager) fetch(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (*awssm.GetSecretValueOutput, error) {
  122. ver := "AWSCURRENT"
  123. valueFrom := "SECRET"
  124. if ref.Version != "" {
  125. ver = ref.Version
  126. }
  127. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  128. valueFrom = "TAG"
  129. }
  130. key := sm.prefix + ref.Key
  131. log.Info("fetching secret value", "key", key, "version", ver, "value", valueFrom)
  132. cacheKey := fmt.Sprintf("%s#%s#%s", key, ver, valueFrom)
  133. if secretOut, found := sm.cache[cacheKey]; found {
  134. log.Info("found secret in cache", "key", key, "version", ver)
  135. return secretOut, nil
  136. }
  137. secretOut, err := sm.constructSecretValue(ctx, key, ver, ref.MetadataPolicy)
  138. if err != nil {
  139. return nil, err
  140. }
  141. sm.cache[cacheKey] = secretOut
  142. return secretOut, nil
  143. }
  144. // DeleteSecret deletes a secret from AWS Secrets Manager.
  145. func (sm *SecretsManager) DeleteSecret(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) error {
  146. secretName := sm.prefix + remoteRef.GetRemoteKey()
  147. secretValue := awssm.GetSecretValueInput{
  148. SecretId: &secretName,
  149. }
  150. secretInput := awssm.DescribeSecretInput{
  151. SecretId: &secretName,
  152. }
  153. awsSecret, err := sm.client.GetSecretValue(ctx, &secretValue)
  154. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
  155. var aerr smithy.APIError
  156. if err != nil {
  157. if ok := errors.As(err, &aerr); !ok {
  158. return err
  159. }
  160. if aerr.ErrorCode() == ResourceNotFoundException {
  161. return nil
  162. }
  163. return err
  164. }
  165. data, err := sm.client.DescribeSecret(ctx, &secretInput)
  166. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
  167. if err != nil {
  168. return err
  169. }
  170. if !isManagedByESO(data) {
  171. return nil
  172. }
  173. deleteInput := &awssm.DeleteSecretInput{
  174. SecretId: awsSecret.ARN,
  175. }
  176. if sm.config != nil && sm.config.ForceDeleteWithoutRecovery {
  177. deleteInput.ForceDeleteWithoutRecovery = &sm.config.ForceDeleteWithoutRecovery
  178. }
  179. if sm.config != nil && sm.config.RecoveryWindowInDays > 0 {
  180. deleteInput.RecoveryWindowInDays = &sm.config.RecoveryWindowInDays
  181. }
  182. err = awsutil.ValidateDeleteSecretInput(*deleteInput)
  183. if err != nil {
  184. return err
  185. }
  186. _, err = sm.client.DeleteSecret(ctx, deleteInput)
  187. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDeleteSecret, err)
  188. return err
  189. }
  190. // SecretExists checks if a secret exists in AWS Secrets Manager.
  191. func (sm *SecretsManager) SecretExists(ctx context.Context, pushSecretRef esv1.PushSecretRemoteRef) (bool, error) {
  192. secretName := sm.prefix + pushSecretRef.GetRemoteKey()
  193. secretValue := awssm.GetSecretValueInput{
  194. SecretId: &secretName,
  195. }
  196. _, err := sm.client.GetSecretValue(ctx, &secretValue)
  197. if err != nil {
  198. return sm.handleSecretError(err)
  199. }
  200. return true, nil
  201. }
  202. func (sm *SecretsManager) handleSecretError(err error) (bool, error) {
  203. var aerr smithy.APIError
  204. if ok := errors.As(err, &aerr); !ok {
  205. return false, err
  206. }
  207. if aerr.ErrorCode() == ResourceNotFoundException {
  208. return false, nil
  209. }
  210. return false, err
  211. }
  212. // PushSecret pushes a secret to AWS Secrets Manager.
  213. func (sm *SecretsManager) PushSecret(ctx context.Context, secret *corev1.Secret, psd esv1.PushSecretData) error {
  214. value, err := esutils.ExtractSecretData(psd, secret)
  215. if err != nil {
  216. return fmt.Errorf("failed to extract secret data: %w", err)
  217. }
  218. secretName := sm.prefix + psd.GetRemoteKey()
  219. describeSecretInput := awssm.DescribeSecretInput{SecretId: &secretName}
  220. describeSecretOutput, err := sm.client.DescribeSecret(ctx, &describeSecretInput)
  221. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
  222. var aerr smithy.APIError
  223. if err != nil {
  224. if ok := errors.As(err, &aerr); !ok {
  225. return err
  226. }
  227. if aerr.ErrorCode() == ResourceNotFoundException {
  228. finalValue, err := sm.getNewSecretValue(value, psd.GetProperty(), nil)
  229. if err != nil {
  230. return err
  231. }
  232. return sm.createSecretWithContext(ctx, secretName, psd, finalValue)
  233. }
  234. return err
  235. } else if !isManagedByESO(describeSecretOutput) {
  236. return errors.New("secret not managed by external-secrets")
  237. }
  238. if len(describeSecretOutput.VersionIdsToStages) == 0 {
  239. finalValue, err := sm.getNewSecretValue(value, psd.GetProperty(), nil)
  240. if err != nil {
  241. return err
  242. }
  243. return sm.putSecretValueWithContext(ctx, secretName, nil, psd, finalValue, describeSecretOutput.Tags)
  244. }
  245. getSecretValueInput := awssm.GetSecretValueInput{SecretId: &secretName}
  246. getSecretValueOutput, err := sm.client.GetSecretValue(ctx, &getSecretValueInput)
  247. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
  248. if err != nil {
  249. return err
  250. }
  251. finalValue, err := sm.getNewSecretValue(value, psd.GetProperty(), getSecretValueOutput)
  252. if err != nil {
  253. return err
  254. }
  255. return sm.putSecretValueWithContext(ctx, secretName, getSecretValueOutput, psd, finalValue, describeSecretOutput.Tags)
  256. }
  257. func (sm *SecretsManager) getNewSecretValue(value []byte, property string, existingSecret *awssm.GetSecretValueOutput) ([]byte, error) {
  258. if property == "" {
  259. return value, nil
  260. }
  261. if existingSecret == nil {
  262. value, _ = sjson.SetBytes([]byte{}, property, value)
  263. return value, nil
  264. }
  265. currentSecret := sm.retrievePayload(existingSecret)
  266. if currentSecret != "" && !gjson.Valid(currentSecret) {
  267. return nil, errors.New("PushSecret for aws secrets manager with a pushSecretData property requires a json secret")
  268. }
  269. value, _ = sjson.SetBytes([]byte(currentSecret), property, value)
  270. return value, nil
  271. }
  272. func isManagedByESO(data *awssm.DescribeSecretOutput) bool {
  273. managedBy := managedBy
  274. externalSecrets := externalSecrets
  275. for _, tag := range data.Tags {
  276. if *tag.Key == managedBy && *tag.Value == externalSecrets {
  277. return true
  278. }
  279. }
  280. return false
  281. }
  282. // GetAllSecrets syncs multiple secrets from aws provider into a single Kubernetes Secret.
  283. func (sm *SecretsManager) GetAllSecrets(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  284. hasName := ref.Name != nil
  285. hasTags := len(ref.Tags) > 0
  286. filters := make([]types.Filter, 0)
  287. switch {
  288. case !hasName && !hasTags:
  289. return nil, errors.New(errUnexpectedFindOperator)
  290. case hasName && !hasTags:
  291. return sm.findByName(ctx, ref, filters)
  292. case !hasName && hasTags:
  293. return sm.findByTags(ctx, ref)
  294. case hasName && hasTags:
  295. return sm.findByNameAndTags(ctx, ref, filters)
  296. default:
  297. return nil, errors.New(errUnexpectedFindOperator)
  298. }
  299. }
  300. func (sm *SecretsManager) findByNameAndTags(ctx context.Context, ref esv1.ExternalSecretFind, filters []types.Filter) (map[string][]byte, error) {
  301. for k, v := range ref.Tags {
  302. filters = append(filters, types.Filter{
  303. Key: types.FilterNameStringTypeTagKey,
  304. Values: []string{
  305. k,
  306. },
  307. }, types.Filter{
  308. Key: types.FilterNameStringTypeTagValue,
  309. Values: []string{
  310. v,
  311. },
  312. })
  313. }
  314. return sm.findByName(ctx, ref, filters)
  315. }
  316. func (sm *SecretsManager) findByName(ctx context.Context, ref esv1.ExternalSecretFind, filters []types.Filter) (map[string][]byte, error) {
  317. matcher, err := find.New(*ref.Name)
  318. if err != nil {
  319. return nil, err
  320. }
  321. if ref.Path != nil {
  322. filters = append(filters, types.Filter{
  323. Key: types.FilterNameStringTypeName,
  324. Values: []string{
  325. *ref.Path,
  326. },
  327. })
  328. return sm.fetchWithBatch(ctx, filters, matcher)
  329. }
  330. data := make(map[string][]byte)
  331. var nextToken *string
  332. for {
  333. // I put this into the for loop on purpose.
  334. log.V(0).Info("using ListSecret to fetch all secrets; this is a costly operations, please use batching by defining a _path_")
  335. it, err := sm.client.ListSecrets(ctx, &awssm.ListSecretsInput{
  336. Filters: filters,
  337. NextToken: nextToken,
  338. })
  339. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMListSecrets, err)
  340. if err != nil {
  341. return nil, err
  342. }
  343. log.V(1).Info("aws sm findByName found", "secrets", len(it.SecretList))
  344. for _, secret := range it.SecretList {
  345. if !matcher.MatchName(*secret.Name) {
  346. continue
  347. }
  348. log.V(1).Info("aws sm findByName matches", "name", *secret.Name)
  349. if err := sm.fetchAndSet(ctx, data, *secret.Name); err != nil {
  350. return nil, err
  351. }
  352. }
  353. nextToken = it.NextToken
  354. if nextToken == nil {
  355. break
  356. }
  357. }
  358. return data, nil
  359. }
  360. func (sm *SecretsManager) findByTags(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  361. filters := make([]types.Filter, 0)
  362. for k, v := range ref.Tags {
  363. filters = append(filters, types.Filter{
  364. Key: types.FilterNameStringTypeTagKey,
  365. Values: []string{
  366. k,
  367. },
  368. }, types.Filter{
  369. Key: types.FilterNameStringTypeTagValue,
  370. Values: []string{
  371. v,
  372. },
  373. })
  374. }
  375. if ref.Path != nil {
  376. filters = append(filters, types.Filter{
  377. Key: types.FilterNameStringTypeName,
  378. Values: []string{
  379. *ref.Path,
  380. },
  381. })
  382. }
  383. return sm.fetchWithBatch(ctx, filters, nil)
  384. }
  385. func (sm *SecretsManager) fetchAndSet(ctx context.Context, data map[string][]byte, name string) error {
  386. sec, err := sm.fetch(ctx, esv1.ExternalSecretDataRemoteRef{
  387. Key: name,
  388. })
  389. if err != nil {
  390. return err
  391. }
  392. if sec.SecretString != nil {
  393. data[name] = []byte(*sec.SecretString)
  394. }
  395. if sec.SecretBinary != nil {
  396. data[name] = sec.SecretBinary
  397. }
  398. return nil
  399. }
  400. // GetSecret returns a single secret from the provider.
  401. func (sm *SecretsManager) GetSecret(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  402. secretOut, err := sm.fetch(ctx, ref)
  403. if errors.Is(err, esv1.NoSecretErr) {
  404. return nil, err
  405. }
  406. if err != nil {
  407. return nil, awsutil.SanitizeErr(err)
  408. }
  409. if ref.Property == "" {
  410. if secretOut.SecretString != nil {
  411. return []byte(*secretOut.SecretString), nil
  412. }
  413. if secretOut.SecretBinary != nil {
  414. return secretOut.SecretBinary, nil
  415. }
  416. return nil, fmt.Errorf("invalid secret received. no secret string nor binary for key: %s", ref.Key)
  417. }
  418. val := sm.mapSecretToGjson(secretOut, ref.Property)
  419. if !val.Exists() {
  420. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  421. }
  422. return []byte(val.String()), nil
  423. }
  424. func (sm *SecretsManager) mapSecretToGjson(secretOut *awssm.GetSecretValueOutput, property string) gjson.Result {
  425. payload := sm.retrievePayload(secretOut)
  426. refProperty := sm.escapeDotsIfRequired(property, payload)
  427. val := gjson.Get(payload, refProperty)
  428. return val
  429. }
  430. func (sm *SecretsManager) retrievePayload(secretOut *awssm.GetSecretValueOutput) string {
  431. if secretOut == nil {
  432. return ""
  433. }
  434. var payload string
  435. if secretOut.SecretString != nil {
  436. payload = *secretOut.SecretString
  437. }
  438. if secretOut.SecretBinary != nil {
  439. payload = string(secretOut.SecretBinary)
  440. }
  441. return payload
  442. }
  443. func (sm *SecretsManager) escapeDotsIfRequired(currentRefProperty, payload string) string {
  444. // We need to search if a given key with a . exists before using gjson operations.
  445. idx := strings.Index(currentRefProperty, ".")
  446. refProperty := currentRefProperty
  447. if idx > -1 {
  448. refProperty = strings.ReplaceAll(currentRefProperty, ".", "\\.")
  449. val := gjson.Get(payload, refProperty)
  450. if !val.Exists() {
  451. refProperty = currentRefProperty
  452. }
  453. }
  454. return refProperty
  455. }
  456. // GetSecretMap returns multiple k/v pairs from the provider.
  457. func (sm *SecretsManager) GetSecretMap(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  458. log.Info("fetching secret map", "key", ref.Key)
  459. data, err := sm.GetSecret(ctx, ref)
  460. if err != nil {
  461. return nil, err
  462. }
  463. kv := make(map[string]json.RawMessage)
  464. err = json.Unmarshal(data, &kv)
  465. if err != nil {
  466. return nil, fmt.Errorf("unable to unmarshal secret %s: %w", ref.Key, err)
  467. }
  468. secretData := make(map[string][]byte)
  469. for k, v := range kv {
  470. var strVal string
  471. err = json.Unmarshal(v, &strVal)
  472. if err == nil {
  473. secretData[k] = []byte(strVal)
  474. } else {
  475. secretData[k] = v
  476. }
  477. }
  478. return secretData, nil
  479. }
  480. // Close closes the provider client connection.
  481. func (sm *SecretsManager) Close(_ context.Context) error {
  482. return nil
  483. }
  484. // Validate validates the provider configuration.
  485. func (sm *SecretsManager) Validate() (esv1.ValidationResult, error) {
  486. // skip validation stack because it depends on the namespace
  487. // of the ExternalSecret
  488. if sm.referentAuth {
  489. return esv1.ValidationResultUnknown, nil
  490. }
  491. _, err := sm.cfg.Credentials.Retrieve(context.Background())
  492. if err != nil {
  493. return esv1.ValidationResultError, awsutil.SanitizeErr(err)
  494. }
  495. return esv1.ValidationResultReady, nil
  496. }
  497. // Capabilities returns the provider's esv1.SecretStoreCapabilities.
  498. func (sm *SecretsManager) Capabilities() esv1.SecretStoreCapabilities {
  499. return esv1.SecretStoreReadWrite
  500. }
  501. func (sm *SecretsManager) createSecretWithContext(ctx context.Context, secretName string, psd esv1.PushSecretData, value []byte) error {
  502. mdata, err := sm.constructMetadataWithDefaults(psd.GetMetadata())
  503. if err != nil {
  504. return fmt.Errorf("failed to parse push secret metadata: %w", err)
  505. }
  506. tags := make([]types.Tag, 0)
  507. for k, v := range mdata.Spec.Tags {
  508. tags = append(tags, types.Tag{
  509. Key: utilpointer.To(k),
  510. Value: utilpointer.To(v),
  511. })
  512. }
  513. input := &awssm.CreateSecretInput{
  514. Name: &secretName,
  515. SecretBinary: value,
  516. Tags: tags,
  517. Description: utilpointer.To(mdata.Spec.Description),
  518. ClientRequestToken: utilpointer.To(initialVersion),
  519. KmsKeyId: utilpointer.To(mdata.Spec.KMSKeyID),
  520. }
  521. if mdata.Spec.SecretPushFormat == SecretPushFormatString {
  522. input.SecretBinary = nil
  523. input.SecretString = aws.String(string(value))
  524. }
  525. createOutput, err := sm.client.CreateSecret(ctx, input)
  526. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMCreateSecret, err)
  527. if err != nil {
  528. return err
  529. }
  530. // Apply resource policy if specified
  531. if mdata.Spec.ResourcePolicy != nil && mdata.Spec.ResourcePolicy.PolicySourceRef != nil {
  532. policyJSON, err := sm.resolveResourcePolicy(ctx, mdata.Spec.ResourcePolicy.PolicySourceRef)
  533. if err != nil {
  534. return fmt.Errorf("failed to resolve resource policy: %w", err)
  535. }
  536. putPolicyInput := &awssm.PutResourcePolicyInput{
  537. SecretId: createOutput.ARN,
  538. ResourcePolicy: aws.String(policyJSON),
  539. }
  540. if mdata.Spec.ResourcePolicy.BlockPublicPolicy != nil {
  541. putPolicyInput.BlockPublicPolicy = mdata.Spec.ResourcePolicy.BlockPublicPolicy
  542. }
  543. _, err = sm.client.PutResourcePolicy(ctx, putPolicyInput)
  544. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutResourcePolicy, err)
  545. if err != nil {
  546. return fmt.Errorf("failed to put resource policy: %w", err)
  547. }
  548. }
  549. return nil
  550. }
  551. func (sm *SecretsManager) putSecretValueWithContext(ctx context.Context, secretArn string, awsSecret *awssm.GetSecretValueOutput, psd esv1.PushSecretData, value []byte, tags []types.Tag) error {
  552. if awsSecret != nil && (bytes.Equal(awsSecret.SecretBinary, value) || esutils.CompareStringAndByteSlices(awsSecret.SecretString, value)) {
  553. return nil
  554. }
  555. newVersionNumber := initialVersion
  556. if awsSecret != nil {
  557. if sm.newUUID == nil {
  558. newVersionNumber = uuid.NewString()
  559. } else {
  560. newVersionNumber = sm.newUUID()
  561. }
  562. }
  563. input := &awssm.PutSecretValueInput{
  564. SecretId: &secretArn,
  565. SecretBinary: value,
  566. ClientRequestToken: aws.String(newVersionNumber),
  567. }
  568. secretPushFormat, err := esutils.FetchValueFromMetadata(SecretPushFormatKey, psd.GetMetadata(), SecretPushFormatBinary)
  569. if err != nil {
  570. return fmt.Errorf("failed to parse metadata: %w", err)
  571. }
  572. if secretPushFormat == SecretPushFormatString {
  573. input.SecretBinary = nil
  574. input.SecretString = aws.String(string(value))
  575. }
  576. _, err = sm.client.PutSecretValue(ctx, input)
  577. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutSecretValue, err)
  578. if err != nil {
  579. return err
  580. }
  581. currentTags := make(map[string]string, len(tags))
  582. for _, tag := range tags {
  583. currentTags[*tag.Key] = *tag.Value
  584. }
  585. if err := sm.patchTags(ctx, psd.GetMetadata(), &secretArn, currentTags); err != nil {
  586. return err
  587. }
  588. // Manage resource policy if specified in metadata
  589. return sm.manageResourcePolicy(ctx, psd.GetMetadata(), &secretArn)
  590. }
  591. func (sm *SecretsManager) patchTags(ctx context.Context, metadata *apiextensionsv1.JSON, secretID *string, tags map[string]string) error {
  592. meta, err := sm.constructMetadataWithDefaults(metadata)
  593. if err != nil {
  594. return err
  595. }
  596. tagKeysToRemove := awsutil.FindTagKeysToRemove(tags, meta.Spec.Tags)
  597. if len(tagKeysToRemove) > 0 {
  598. _, err = sm.client.UntagResource(ctx, &awssm.UntagResourceInput{
  599. SecretId: secretID,
  600. TagKeys: tagKeysToRemove,
  601. })
  602. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMUntagResource, err)
  603. if err != nil {
  604. return err
  605. }
  606. }
  607. tagsToUpdate, isModified := computeTagsToUpdate(tags, meta.Spec.Tags)
  608. if isModified {
  609. _, err = sm.client.TagResource(ctx, &awssm.TagResourceInput{
  610. SecretId: secretID,
  611. Tags: tagsToUpdate,
  612. })
  613. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMTagResource, err)
  614. if err != nil {
  615. return err
  616. }
  617. }
  618. return nil
  619. }
  620. func (sm *SecretsManager) fetchWithBatch(ctx context.Context, filters []types.Filter, matcher *find.Matcher) (map[string][]byte, error) {
  621. data := make(map[string][]byte)
  622. var nextToken *string
  623. for {
  624. it, err := sm.client.BatchGetSecretValue(ctx, &awssm.BatchGetSecretValueInput{
  625. Filters: filters,
  626. NextToken: nextToken,
  627. })
  628. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMBatchGetSecretValue, err)
  629. if err != nil {
  630. return nil, err
  631. }
  632. log.V(1).Info("aws sm findByName found", "secrets", len(it.SecretValues))
  633. for _, secret := range it.SecretValues {
  634. if matcher != nil && !matcher.MatchName(*secret.Name) {
  635. continue
  636. }
  637. log.V(1).Info("aws sm findByName matches", "name", *secret.Name)
  638. sm.setSecretValues(&secret, data)
  639. }
  640. nextToken = it.NextToken
  641. if nextToken == nil {
  642. break
  643. }
  644. }
  645. return data, nil
  646. }
  647. func (sm *SecretsManager) setSecretValues(secret *types.SecretValueEntry, data map[string][]byte) {
  648. if secret.SecretString != nil {
  649. data[*secret.Name] = []byte(*secret.SecretString)
  650. }
  651. if secret.SecretBinary != nil {
  652. data[*secret.Name] = secret.SecretBinary
  653. }
  654. }
  655. func (sm *SecretsManager) constructSecretValue(ctx context.Context, key, ver string, metadataPolicy esv1.ExternalSecretMetadataPolicy) (*awssm.GetSecretValueOutput, error) {
  656. if metadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  657. describeSecretInput := &awssm.DescribeSecretInput{
  658. SecretId: &key,
  659. }
  660. descOutput, err := sm.client.DescribeSecret(ctx, describeSecretInput)
  661. if err != nil {
  662. return nil, err
  663. }
  664. log.Info("found metadata secret", "key", key, "output", descOutput)
  665. jsonTags, err := awsutil.SecretTagsToJSONString(descOutput.Tags)
  666. if err != nil {
  667. return nil, err
  668. }
  669. return &awssm.GetSecretValueOutput{
  670. ARN: descOutput.ARN,
  671. CreatedDate: descOutput.CreatedDate,
  672. Name: descOutput.Name,
  673. SecretString: &jsonTags,
  674. VersionId: &ver,
  675. }, nil
  676. }
  677. var getSecretValueInput *awssm.GetSecretValueInput
  678. if strings.HasPrefix(ver, "uuid/") {
  679. versionID := strings.TrimPrefix(ver, "uuid/")
  680. getSecretValueInput = &awssm.GetSecretValueInput{
  681. SecretId: &key,
  682. VersionId: &versionID,
  683. }
  684. } else {
  685. getSecretValueInput = &awssm.GetSecretValueInput{
  686. SecretId: &key,
  687. VersionStage: &ver,
  688. }
  689. }
  690. secretOut, err := sm.client.GetSecretValue(ctx, getSecretValueInput)
  691. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
  692. var (
  693. nf *types.ResourceNotFoundException
  694. ie *types.InvalidParameterException
  695. )
  696. if errors.As(err, &nf) {
  697. return nil, esv1.NoSecretErr
  698. }
  699. if errors.As(err, &ie) && strings.Contains(ie.Error(), "was marked for deletion") {
  700. return nil, esv1.NoSecretErr
  701. }
  702. return secretOut, err
  703. }
  704. func (sm *SecretsManager) constructMetadataWithDefaults(data *apiextensionsv1.JSON) (*metadata.PushSecretMetadata[PushSecretMetadataSpec], error) {
  705. var (
  706. meta *metadata.PushSecretMetadata[PushSecretMetadataSpec]
  707. err error
  708. )
  709. meta, err = metadata.ParseMetadataParameters[PushSecretMetadataSpec](data)
  710. if err != nil {
  711. return nil, fmt.Errorf("failed to parse metadata: %w", err)
  712. }
  713. if meta == nil {
  714. meta = &metadata.PushSecretMetadata[PushSecretMetadataSpec]{}
  715. }
  716. if meta.Spec.SecretPushFormat == "" {
  717. meta.Spec.SecretPushFormat = SecretPushFormatBinary
  718. } else if !slices.Contains([]string{SecretPushFormatBinary, SecretPushFormatString}, meta.Spec.SecretPushFormat) {
  719. return nil, fmt.Errorf("invalid secret push format: %s", meta.Spec.SecretPushFormat)
  720. }
  721. if meta.Spec.Description == "" {
  722. meta.Spec.Description = fmt.Sprintf("secret '%s:%s'", managedBy, externalSecrets)
  723. }
  724. if meta.Spec.KMSKeyID == "" {
  725. meta.Spec.KMSKeyID = "alias/aws/secretsmanager"
  726. }
  727. if len(meta.Spec.Tags) > 0 {
  728. if _, exists := meta.Spec.Tags[managedBy]; exists {
  729. return nil, fmt.Errorf("error parsing tags in metadata: Cannot specify a '%s' tag", managedBy)
  730. }
  731. } else {
  732. meta.Spec.Tags = make(map[string]string)
  733. }
  734. meta.Spec.Tags[managedBy] = externalSecrets
  735. return meta, nil
  736. }
  737. // resolveResourcePolicy resolves the policy JSON from the PolicySourceRef.
  738. func (sm *SecretsManager) resolveResourcePolicy(ctx context.Context, policyRef *PolicySourceRef) (string, error) {
  739. if policyRef == nil {
  740. return "", errors.New("policySourceRef is nil")
  741. }
  742. switch policyRef.Kind {
  743. case "ConfigMap":
  744. cm := &corev1.ConfigMap{}
  745. if err := sm.kube.Get(ctx, client.ObjectKey{
  746. Namespace: sm.namespace,
  747. Name: policyRef.Name,
  748. }, cm); err != nil {
  749. return "", fmt.Errorf("failed to get ConfigMap %s/%s: %w", sm.namespace, policyRef.Name, err)
  750. }
  751. policy, ok := cm.Data[policyRef.Key]
  752. if !ok {
  753. return "", fmt.Errorf("key %s not found in ConfigMap %s/%s", policyRef.Key, sm.namespace, policyRef.Name)
  754. }
  755. return policy, nil
  756. case "Secret":
  757. secret := &corev1.Secret{}
  758. if err := sm.kube.Get(ctx, client.ObjectKey{
  759. Namespace: sm.namespace,
  760. Name: policyRef.Name,
  761. }, secret); err != nil {
  762. return "", fmt.Errorf("failed to get Secret %s/%s: %w", sm.namespace, policyRef.Name, err)
  763. }
  764. policyBytes, ok := secret.Data[policyRef.Key]
  765. if !ok {
  766. return "", fmt.Errorf("key %s not found in Secret %s/%s", policyRef.Key, sm.namespace, policyRef.Name)
  767. }
  768. return string(policyBytes), nil
  769. default:
  770. return "", fmt.Errorf("unsupported PolicySourceRef kind: %s (must be ConfigMap or Secret)", policyRef.Kind)
  771. }
  772. }
  773. // manageResourcePolicy applies or removes the resource policy based on metadata.
  774. func (sm *SecretsManager) manageResourcePolicy(ctx context.Context, metadata *apiextensionsv1.JSON, secretID *string) error {
  775. meta, err := sm.constructMetadataWithDefaults(metadata)
  776. if err != nil {
  777. return err
  778. }
  779. // Delete policy if policyRef is nil and the policy exists.
  780. if meta.Spec.ResourcePolicy == nil {
  781. deletePolicyInput := &awssm.DeleteResourcePolicyInput{
  782. SecretId: secretID,
  783. }
  784. _, err = sm.client.DeleteResourcePolicy(ctx, deletePolicyInput)
  785. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDeleteResourcePolicy, err)
  786. var nf *types.ResourceNotFoundException
  787. if err != nil && !errors.As(err, &nf) {
  788. return fmt.Errorf("failed to delete resource policy: %w", err)
  789. }
  790. return nil
  791. }
  792. // Normal flow, is to create the policy.
  793. policyJSON, err := sm.resolveResourcePolicy(ctx, meta.Spec.ResourcePolicy.PolicySourceRef)
  794. if err != nil {
  795. return fmt.Errorf("failed to resolve resource policy: %w", err)
  796. }
  797. getCurrentPolicyInput := &awssm.GetResourcePolicyInput{
  798. SecretId: secretID,
  799. }
  800. currentPolicyOutput, err := sm.client.GetResourcePolicy(ctx, getCurrentPolicyInput)
  801. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetResourcePolicy, err)
  802. var nf *types.ResourceNotFoundException
  803. if err != nil && !errors.As(err, &nf) {
  804. return fmt.Errorf("failed to get current resource policy: %w", err)
  805. }
  806. currentPolicy := ""
  807. if currentPolicyOutput != nil && currentPolicyOutput.ResourcePolicy != nil {
  808. currentPolicy = *currentPolicyOutput.ResourcePolicy
  809. }
  810. // convert to maps so we can do a stable comparison.
  811. var (
  812. currentPolicyMap map[string]any
  813. policyJSONMaps map[string]any
  814. )
  815. if err := json.Unmarshal([]byte(currentPolicy), &currentPolicyMap); err != nil {
  816. return fmt.Errorf("failed to unmarshal current resource policy: %w", err)
  817. }
  818. if err := json.Unmarshal([]byte(policyJSON), &policyJSONMaps); err != nil {
  819. return fmt.Errorf("failed to unmarshal current resource policy: %w", err)
  820. }
  821. if reflect.DeepEqual(currentPolicyMap, policyJSONMaps) {
  822. return nil
  823. }
  824. putPolicyInput := &awssm.PutResourcePolicyInput{
  825. SecretId: secretID,
  826. ResourcePolicy: aws.String(policyJSON),
  827. }
  828. if meta.Spec.ResourcePolicy.BlockPublicPolicy != nil {
  829. putPolicyInput.BlockPublicPolicy = meta.Spec.ResourcePolicy.BlockPublicPolicy
  830. }
  831. _, err = sm.client.PutResourcePolicy(ctx, putPolicyInput)
  832. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutResourcePolicy, err)
  833. if err != nil {
  834. return fmt.Errorf("failed to put resource policy: %w", err)
  835. }
  836. return nil
  837. }
  838. // computeTagsToUpdate compares the current tags with the desired metaTags and returns a slice of ssmTypes.Tag
  839. // that should be set on the resource. It also returns a boolean indicating if any tag was added or modified.
  840. func computeTagsToUpdate(tags, metaTags map[string]string) ([]types.Tag, bool) {
  841. result := make([]types.Tag, 0, len(metaTags))
  842. modified := false
  843. for k, v := range metaTags {
  844. if _, exists := tags[k]; !exists || tags[k] != v {
  845. if k != managedBy {
  846. modified = true
  847. }
  848. }
  849. result = append(result, types.Tag{
  850. Key: utilpointer.To(k),
  851. Value: utilpointer.To(v),
  852. })
  853. }
  854. return result, modified
  855. }