secretsmanager.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714
  1. /*
  2. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. http://www.apache.org/licenses/LICENSE-2.0
  6. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package secretsmanager
  13. import (
  14. "bytes"
  15. "context"
  16. "encoding/json"
  17. "errors"
  18. "fmt"
  19. "math/big"
  20. "slices"
  21. "strings"
  22. "github.com/aws/aws-sdk-go/aws"
  23. "github.com/aws/aws-sdk-go/aws/awserr"
  24. "github.com/aws/aws-sdk-go/aws/request"
  25. "github.com/aws/aws-sdk-go/aws/session"
  26. awssm "github.com/aws/aws-sdk-go/service/secretsmanager"
  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. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  35. "github.com/external-secrets/external-secrets/pkg/constants"
  36. "github.com/external-secrets/external-secrets/pkg/find"
  37. "github.com/external-secrets/external-secrets/pkg/metrics"
  38. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  39. "github.com/external-secrets/external-secrets/pkg/utils"
  40. "github.com/external-secrets/external-secrets/pkg/utils/metadata"
  41. )
  42. type PushSecretMetadataSpec struct {
  43. Tags map[string]string `json:"tags,omitempty"`
  44. Description string `json:"description,omitempty"`
  45. SecretPushFormat string `json:"secretPushFormat,omitempty"`
  46. KMSKeyID string `json:"kmsKeyId,omitempty"`
  47. }
  48. // Declares metadata information for pushing secrets to AWS Secret Store.
  49. const (
  50. SecretPushFormatKey = "secretPushFormat"
  51. SecretPushFormatString = "string"
  52. SecretPushFormatBinary = "binary"
  53. )
  54. // https://github.com/external-secrets/external-secrets/issues/644
  55. var _ esv1.SecretsClient = &SecretsManager{}
  56. // SecretsManager is a provider for AWS SecretsManager.
  57. type SecretsManager struct {
  58. sess *session.Session
  59. client SMInterface
  60. referentAuth bool
  61. cache map[string]*awssm.GetSecretValueOutput
  62. config *esv1.SecretsManager
  63. prefix string
  64. }
  65. // SMInterface is a subset of the smiface api.
  66. // see: https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/secretsmanageriface/
  67. type SMInterface interface {
  68. BatchGetSecretValueWithContext(aws.Context, *awssm.BatchGetSecretValueInput, ...request.Option) (*awssm.BatchGetSecretValueOutput, error)
  69. ListSecrets(*awssm.ListSecretsInput) (*awssm.ListSecretsOutput, error)
  70. GetSecretValue(*awssm.GetSecretValueInput) (*awssm.GetSecretValueOutput, error)
  71. CreateSecretWithContext(aws.Context, *awssm.CreateSecretInput, ...request.Option) (*awssm.CreateSecretOutput, error)
  72. GetSecretValueWithContext(aws.Context, *awssm.GetSecretValueInput, ...request.Option) (*awssm.GetSecretValueOutput, error)
  73. PutSecretValueWithContext(aws.Context, *awssm.PutSecretValueInput, ...request.Option) (*awssm.PutSecretValueOutput, error)
  74. DescribeSecretWithContext(aws.Context, *awssm.DescribeSecretInput, ...request.Option) (*awssm.DescribeSecretOutput, error)
  75. DeleteSecretWithContext(ctx aws.Context, input *awssm.DeleteSecretInput, opts ...request.Option) (*awssm.DeleteSecretOutput, error)
  76. }
  77. const (
  78. errUnexpectedFindOperator = "unexpected find operator"
  79. managedBy = "managed-by"
  80. externalSecrets = "external-secrets"
  81. initialVersion = "00000000-0000-0000-0000-000000000001"
  82. )
  83. var log = ctrl.Log.WithName("provider").WithName("aws").WithName("secretsmanager")
  84. // New creates a new SecretsManager client.
  85. func New(sess *session.Session, cfg *aws.Config, secretsManagerCfg *esv1.SecretsManager, prefix string, referentAuth bool) (*SecretsManager, error) {
  86. return &SecretsManager{
  87. sess: sess,
  88. client: awssm.New(sess, cfg),
  89. referentAuth: referentAuth,
  90. cache: make(map[string]*awssm.GetSecretValueOutput),
  91. config: secretsManagerCfg,
  92. prefix: prefix,
  93. }, nil
  94. }
  95. func (sm *SecretsManager) fetch(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (*awssm.GetSecretValueOutput, error) {
  96. ver := "AWSCURRENT"
  97. valueFrom := "SECRET"
  98. if ref.Version != "" {
  99. ver = ref.Version
  100. }
  101. if ref.MetadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  102. valueFrom = "TAG"
  103. }
  104. key := sm.prefix + ref.Key
  105. log.Info("fetching secret value", "key", key, "version", ver, "value", valueFrom)
  106. cacheKey := fmt.Sprintf("%s#%s#%s", key, ver, valueFrom)
  107. if secretOut, found := sm.cache[cacheKey]; found {
  108. log.Info("found secret in cache", "key", key, "version", ver)
  109. return secretOut, nil
  110. }
  111. secretOut, err := sm.constructSecretValue(ctx, key, ver, ref.MetadataPolicy)
  112. if err != nil {
  113. return nil, err
  114. }
  115. sm.cache[cacheKey] = secretOut
  116. return secretOut, nil
  117. }
  118. func (sm *SecretsManager) DeleteSecret(ctx context.Context, remoteRef esv1.PushSecretRemoteRef) error {
  119. secretName := sm.prefix + remoteRef.GetRemoteKey()
  120. secretValue := awssm.GetSecretValueInput{
  121. SecretId: &secretName,
  122. }
  123. secretInput := awssm.DescribeSecretInput{
  124. SecretId: &secretName,
  125. }
  126. awsSecret, err := sm.client.GetSecretValueWithContext(ctx, &secretValue)
  127. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
  128. var aerr awserr.Error
  129. if err != nil {
  130. if ok := errors.As(err, &aerr); !ok {
  131. return err
  132. }
  133. if aerr.Code() == awssm.ErrCodeResourceNotFoundException {
  134. return nil
  135. }
  136. return err
  137. }
  138. data, err := sm.client.DescribeSecretWithContext(ctx, &secretInput)
  139. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
  140. if err != nil {
  141. return err
  142. }
  143. if !isManagedByESO(data) {
  144. return nil
  145. }
  146. deleteInput := &awssm.DeleteSecretInput{
  147. SecretId: awsSecret.ARN,
  148. }
  149. if sm.config != nil && sm.config.ForceDeleteWithoutRecovery {
  150. deleteInput.ForceDeleteWithoutRecovery = &sm.config.ForceDeleteWithoutRecovery
  151. }
  152. if sm.config != nil && sm.config.RecoveryWindowInDays > 0 {
  153. deleteInput.RecoveryWindowInDays = &sm.config.RecoveryWindowInDays
  154. }
  155. err = util.ValidateDeleteSecretInput(*deleteInput)
  156. if err != nil {
  157. return err
  158. }
  159. _, err = sm.client.DeleteSecretWithContext(ctx, deleteInput)
  160. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDeleteSecret, err)
  161. return err
  162. }
  163. func (sm *SecretsManager) SecretExists(ctx context.Context, pushSecretRef esv1.PushSecretRemoteRef) (bool, error) {
  164. secretName := sm.prefix + pushSecretRef.GetRemoteKey()
  165. secretValue := awssm.GetSecretValueInput{
  166. SecretId: &secretName,
  167. }
  168. _, err := sm.client.GetSecretValueWithContext(ctx, &secretValue)
  169. if err != nil {
  170. return sm.handleSecretError(err)
  171. }
  172. return true, nil
  173. }
  174. func (sm *SecretsManager) handleSecretError(err error) (bool, error) {
  175. var aerr awserr.Error
  176. if ok := errors.As(err, &aerr); !ok {
  177. return false, err
  178. }
  179. if aerr.Code() == awssm.ErrCodeResourceNotFoundException {
  180. return false, nil
  181. }
  182. return false, err
  183. }
  184. func (sm *SecretsManager) PushSecret(ctx context.Context, secret *corev1.Secret, psd esv1.PushSecretData) error {
  185. value, err := utils.ExtractSecretData(psd, secret)
  186. if err != nil {
  187. return fmt.Errorf("failed to extract secret data: %w", err)
  188. }
  189. secretName := sm.prefix + psd.GetRemoteKey()
  190. secretValue := awssm.GetSecretValueInput{
  191. SecretId: &secretName,
  192. }
  193. secretInput := awssm.DescribeSecretInput{
  194. SecretId: &secretName,
  195. }
  196. awsSecret, err := sm.client.GetSecretValueWithContext(ctx, &secretValue)
  197. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
  198. if psd.GetProperty() != "" {
  199. currentSecret := sm.retrievePayload(awsSecret)
  200. if currentSecret != "" && !gjson.Valid(currentSecret) {
  201. return errors.New("PushSecret for aws secrets manager with a pushSecretData property requires a json secret")
  202. }
  203. value, _ = sjson.SetBytes([]byte(currentSecret), psd.GetProperty(), value)
  204. }
  205. var aerr awserr.Error
  206. if err != nil {
  207. if ok := errors.As(err, &aerr); !ok {
  208. return err
  209. }
  210. if aerr.Code() == awssm.ErrCodeResourceNotFoundException {
  211. return sm.createSecretWithContext(ctx, secretName, psd, value)
  212. }
  213. return err
  214. }
  215. return sm.putSecretValueWithContext(ctx, secretInput, awsSecret, psd, value)
  216. }
  217. func padOrTrim(b []byte) []byte {
  218. l := len(b)
  219. size := 16
  220. if l == size {
  221. return b
  222. }
  223. if l > size {
  224. return b[l-size:]
  225. }
  226. tmp := make([]byte, size)
  227. copy(tmp[size-l:], b)
  228. return tmp
  229. }
  230. func bumpVersionNumber(id *string) (*string, error) {
  231. if id == nil {
  232. output := initialVersion
  233. return &output, nil
  234. }
  235. n := new(big.Int)
  236. oldVersion, ok := n.SetString(strings.ReplaceAll(*id, "-", ""), 16)
  237. if !ok {
  238. return nil, fmt.Errorf("expected secret version in AWS SSM to be a UUID but got '%s'", *id)
  239. }
  240. newVersionRaw := oldVersion.Add(oldVersion, big.NewInt(1)).Bytes()
  241. newVersion, err := uuid.FromBytes(padOrTrim(newVersionRaw))
  242. if err != nil {
  243. return nil, err
  244. }
  245. s := newVersion.String()
  246. return &s, nil
  247. }
  248. func isManagedByESO(data *awssm.DescribeSecretOutput) bool {
  249. managedBy := managedBy
  250. externalSecrets := externalSecrets
  251. for _, tag := range data.Tags {
  252. if *tag.Key == managedBy && *tag.Value == externalSecrets {
  253. return true
  254. }
  255. }
  256. return false
  257. }
  258. // GetAllSecrets syncs multiple secrets from aws provider into a single Kubernetes Secret.
  259. func (sm *SecretsManager) GetAllSecrets(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  260. if ref.Name != nil {
  261. return sm.findByName(ctx, ref)
  262. }
  263. if len(ref.Tags) > 0 {
  264. return sm.findByTags(ctx, ref)
  265. }
  266. return nil, errors.New(errUnexpectedFindOperator)
  267. }
  268. func (sm *SecretsManager) findByName(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  269. matcher, err := find.New(*ref.Name)
  270. if err != nil {
  271. return nil, err
  272. }
  273. filters := make([]*awssm.Filter, 0)
  274. if ref.Path != nil {
  275. filters = append(filters, &awssm.Filter{
  276. Key: utilpointer.To(awssm.FilterNameStringTypeName),
  277. Values: []*string{
  278. ref.Path,
  279. },
  280. })
  281. return sm.fetchWithBatch(ctx, filters, matcher)
  282. }
  283. data := make(map[string][]byte)
  284. var nextToken *string
  285. for {
  286. // I put this into the for loop on purpose.
  287. log.V(0).Info("using ListSecret to fetch all secrets; this is a costly operations, please use batching by defining a _path_")
  288. it, err := sm.client.ListSecrets(&awssm.ListSecretsInput{
  289. Filters: filters,
  290. NextToken: nextToken,
  291. })
  292. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMListSecrets, err)
  293. if err != nil {
  294. return nil, err
  295. }
  296. log.V(1).Info("aws sm findByName found", "secrets", len(it.SecretList))
  297. for _, secret := range it.SecretList {
  298. if !matcher.MatchName(*secret.Name) {
  299. continue
  300. }
  301. log.V(1).Info("aws sm findByName matches", "name", *secret.Name)
  302. if err := sm.fetchAndSet(ctx, data, *secret.Name); err != nil {
  303. return nil, err
  304. }
  305. }
  306. nextToken = it.NextToken
  307. if nextToken == nil {
  308. break
  309. }
  310. }
  311. return data, nil
  312. }
  313. func (sm *SecretsManager) findByTags(ctx context.Context, ref esv1.ExternalSecretFind) (map[string][]byte, error) {
  314. filters := make([]*awssm.Filter, 0)
  315. for k, v := range ref.Tags {
  316. filters = append(filters, &awssm.Filter{
  317. Key: utilpointer.To(awssm.FilterNameStringTypeTagKey),
  318. Values: []*string{
  319. utilpointer.To(k),
  320. },
  321. }, &awssm.Filter{
  322. Key: utilpointer.To(awssm.FilterNameStringTypeTagValue),
  323. Values: []*string{
  324. utilpointer.To(v),
  325. },
  326. })
  327. }
  328. if ref.Path != nil {
  329. filters = append(filters, &awssm.Filter{
  330. Key: utilpointer.To(awssm.FilterNameStringTypeName),
  331. Values: []*string{
  332. ref.Path,
  333. },
  334. })
  335. }
  336. return sm.fetchWithBatch(ctx, filters, nil)
  337. }
  338. func (sm *SecretsManager) fetchAndSet(ctx context.Context, data map[string][]byte, name string) error {
  339. sec, err := sm.fetch(ctx, esv1.ExternalSecretDataRemoteRef{
  340. Key: name,
  341. })
  342. if err != nil {
  343. return err
  344. }
  345. if sec.SecretString != nil {
  346. data[name] = []byte(*sec.SecretString)
  347. }
  348. if sec.SecretBinary != nil {
  349. data[name] = sec.SecretBinary
  350. }
  351. return nil
  352. }
  353. // GetSecret returns a single secret from the provider.
  354. func (sm *SecretsManager) GetSecret(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
  355. secretOut, err := sm.fetch(ctx, ref)
  356. if errors.Is(err, esv1.NoSecretErr) {
  357. return nil, err
  358. }
  359. if err != nil {
  360. return nil, util.SanitizeErr(err)
  361. }
  362. if ref.Property == "" {
  363. if secretOut.SecretString != nil {
  364. return []byte(*secretOut.SecretString), nil
  365. }
  366. if secretOut.SecretBinary != nil {
  367. return secretOut.SecretBinary, nil
  368. }
  369. return nil, fmt.Errorf("invalid secret received. no secret string nor binary for key: %s", ref.Key)
  370. }
  371. val := sm.mapSecretToGjson(secretOut, ref.Property)
  372. if !val.Exists() {
  373. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  374. }
  375. return []byte(val.String()), nil
  376. }
  377. func (sm *SecretsManager) mapSecretToGjson(secretOut *awssm.GetSecretValueOutput, property string) gjson.Result {
  378. payload := sm.retrievePayload(secretOut)
  379. refProperty := sm.escapeDotsIfRequired(property, payload)
  380. val := gjson.Get(payload, refProperty)
  381. return val
  382. }
  383. func (sm *SecretsManager) retrievePayload(secretOut *awssm.GetSecretValueOutput) string {
  384. var payload string
  385. if secretOut.SecretString != nil {
  386. payload = *secretOut.SecretString
  387. }
  388. if secretOut.SecretBinary != nil {
  389. payload = string(secretOut.SecretBinary)
  390. }
  391. return payload
  392. }
  393. func (sm *SecretsManager) escapeDotsIfRequired(currentRefProperty, payload string) string {
  394. // We need to search if a given key with a . exists before using gjson operations.
  395. idx := strings.Index(currentRefProperty, ".")
  396. refProperty := currentRefProperty
  397. if idx > -1 {
  398. refProperty = strings.ReplaceAll(currentRefProperty, ".", "\\.")
  399. val := gjson.Get(payload, refProperty)
  400. if !val.Exists() {
  401. refProperty = currentRefProperty
  402. }
  403. }
  404. return refProperty
  405. }
  406. // GetSecretMap returns multiple k/v pairs from the provider.
  407. func (sm *SecretsManager) GetSecretMap(ctx context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  408. log.Info("fetching secret map", "key", ref.Key)
  409. data, err := sm.GetSecret(ctx, ref)
  410. if err != nil {
  411. return nil, err
  412. }
  413. kv := make(map[string]json.RawMessage)
  414. err = json.Unmarshal(data, &kv)
  415. if err != nil {
  416. return nil, fmt.Errorf("unable to unmarshal secret %s: %w", ref.Key, err)
  417. }
  418. secretData := make(map[string][]byte)
  419. for k, v := range kv {
  420. var strVal string
  421. err = json.Unmarshal(v, &strVal)
  422. if err == nil {
  423. secretData[k] = []byte(strVal)
  424. } else {
  425. secretData[k] = v
  426. }
  427. }
  428. return secretData, nil
  429. }
  430. func (sm *SecretsManager) Close(_ context.Context) error {
  431. return nil
  432. }
  433. func (sm *SecretsManager) Validate() (esv1.ValidationResult, error) {
  434. // skip validation stack because it depends on the namespace
  435. // of the ExternalSecret
  436. if sm.referentAuth {
  437. return esv1.ValidationResultUnknown, nil
  438. }
  439. _, err := sm.sess.Config.Credentials.Get()
  440. if err != nil {
  441. return esv1.ValidationResultError, util.SanitizeErr(err)
  442. }
  443. return esv1.ValidationResultReady, nil
  444. }
  445. func (sm *SecretsManager) Capabilities() esv1.SecretStoreCapabilities {
  446. return esv1.SecretStoreReadWrite
  447. }
  448. func (sm *SecretsManager) createSecretWithContext(ctx context.Context, secretName string, psd esv1.PushSecretData, value []byte) error {
  449. mdata, err := sm.constructMetadataWithDefaults(psd.GetMetadata())
  450. if err != nil {
  451. return fmt.Errorf("failed to parse push secret metadata: %w", err)
  452. }
  453. tags := []*awssm.Tag{
  454. {
  455. Key: utilpointer.To(managedBy),
  456. Value: utilpointer.To(externalSecrets),
  457. },
  458. }
  459. for k, v := range mdata.Spec.Tags {
  460. tags = append(tags, &awssm.Tag{
  461. Key: utilpointer.To(k),
  462. Value: utilpointer.To(v),
  463. })
  464. }
  465. input := &awssm.CreateSecretInput{
  466. Name: &secretName,
  467. SecretBinary: value,
  468. Tags: tags,
  469. Description: utilpointer.To(mdata.Spec.Description),
  470. ClientRequestToken: utilpointer.To(initialVersion),
  471. KmsKeyId: utilpointer.To(mdata.Spec.KMSKeyID),
  472. }
  473. if mdata.Spec.SecretPushFormat == SecretPushFormatString {
  474. input.SetSecretBinary(nil).SetSecretString(string(value))
  475. }
  476. err = input.Validate()
  477. if err != nil {
  478. return fmt.Errorf("failed to validate input: %w", err)
  479. }
  480. _, err = sm.client.CreateSecretWithContext(ctx, input)
  481. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMCreateSecret, err)
  482. return err
  483. }
  484. func (sm *SecretsManager) putSecretValueWithContext(ctx context.Context, secretInput awssm.DescribeSecretInput, awsSecret *awssm.GetSecretValueOutput, psd esv1.PushSecretData, value []byte) error {
  485. data, err := sm.client.DescribeSecretWithContext(ctx, &secretInput)
  486. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMDescribeSecret, err)
  487. if err != nil {
  488. return err
  489. }
  490. if !isManagedByESO(data) {
  491. return errors.New("secret not managed by external-secrets")
  492. }
  493. if awsSecret != nil && bytes.Equal(awsSecret.SecretBinary, value) || utils.CompareStringAndByteSlices(awsSecret.SecretString, value) {
  494. return nil
  495. }
  496. newVersionNumber, err := bumpVersionNumber(awsSecret.VersionId)
  497. if err != nil {
  498. return err
  499. }
  500. input := &awssm.PutSecretValueInput{
  501. SecretId: awsSecret.ARN,
  502. SecretBinary: value,
  503. ClientRequestToken: newVersionNumber,
  504. }
  505. secretPushFormat, err := utils.FetchValueFromMetadata(SecretPushFormatKey, psd.GetMetadata(), SecretPushFormatBinary)
  506. if err != nil {
  507. return fmt.Errorf("failed to parse metadata: %w", err)
  508. }
  509. if secretPushFormat == SecretPushFormatString {
  510. input.SetSecretBinary(nil).SetSecretString(string(value))
  511. }
  512. _, err = sm.client.PutSecretValueWithContext(ctx, input)
  513. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMPutSecretValue, err)
  514. return err
  515. }
  516. func (sm *SecretsManager) fetchWithBatch(ctx context.Context, filters []*awssm.Filter, matcher *find.Matcher) (map[string][]byte, error) {
  517. data := make(map[string][]byte)
  518. var nextToken *string
  519. for {
  520. it, err := sm.client.BatchGetSecretValueWithContext(ctx, &awssm.BatchGetSecretValueInput{
  521. Filters: filters,
  522. NextToken: nextToken,
  523. })
  524. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMBatchGetSecretValue, err)
  525. if err != nil {
  526. return nil, err
  527. }
  528. log.V(1).Info("aws sm findByName found", "secrets", len(it.SecretValues))
  529. for _, secret := range it.SecretValues {
  530. if matcher != nil && !matcher.MatchName(*secret.Name) {
  531. continue
  532. }
  533. log.V(1).Info("aws sm findByName matches", "name", *secret.Name)
  534. sm.setSecretValues(secret, data)
  535. }
  536. nextToken = it.NextToken
  537. if nextToken == nil {
  538. break
  539. }
  540. }
  541. return data, nil
  542. }
  543. func (sm *SecretsManager) setSecretValues(secret *awssm.SecretValueEntry, data map[string][]byte) {
  544. if secret.SecretString != nil {
  545. data[*secret.Name] = []byte(*secret.SecretString)
  546. }
  547. if secret.SecretBinary != nil {
  548. data[*secret.Name] = secret.SecretBinary
  549. }
  550. }
  551. func (sm *SecretsManager) constructSecretValue(ctx context.Context, key, ver string, metadataPolicy esv1.ExternalSecretMetadataPolicy) (*awssm.GetSecretValueOutput, error) {
  552. if metadataPolicy == esv1.ExternalSecretMetadataPolicyFetch {
  553. describeSecretInput := &awssm.DescribeSecretInput{
  554. SecretId: &key,
  555. }
  556. descOutput, err := sm.client.DescribeSecretWithContext(ctx, describeSecretInput)
  557. if err != nil {
  558. return nil, err
  559. }
  560. log.Info("found metadata secret", "key", key, "output", descOutput)
  561. jsonTags, err := util.SecretTagsToJSONString(descOutput.Tags)
  562. if err != nil {
  563. return nil, err
  564. }
  565. return &awssm.GetSecretValueOutput{
  566. ARN: descOutput.ARN,
  567. CreatedDate: descOutput.CreatedDate,
  568. Name: descOutput.Name,
  569. SecretString: &jsonTags,
  570. VersionId: &ver,
  571. }, nil
  572. }
  573. var getSecretValueInput *awssm.GetSecretValueInput
  574. if strings.HasPrefix(ver, "uuid/") {
  575. versionID := strings.TrimPrefix(ver, "uuid/")
  576. getSecretValueInput = &awssm.GetSecretValueInput{
  577. SecretId: &key,
  578. VersionId: &versionID,
  579. }
  580. } else {
  581. getSecretValueInput = &awssm.GetSecretValueInput{
  582. SecretId: &key,
  583. VersionStage: &ver,
  584. }
  585. }
  586. secretOut, err := sm.client.GetSecretValue(getSecretValueInput)
  587. metrics.ObserveAPICall(constants.ProviderAWSSM, constants.CallAWSSMGetSecretValue, err)
  588. var (
  589. nf *awssm.ResourceNotFoundException
  590. ie *awssm.InvalidRequestException
  591. )
  592. if errors.As(err, &nf) {
  593. return nil, esv1.NoSecretErr
  594. }
  595. if errors.As(err, &ie) && strings.Contains(ie.Error(), "was marked for deletion") {
  596. return nil, esv1.NoSecretErr
  597. }
  598. return secretOut, err
  599. }
  600. func (sm *SecretsManager) constructMetadataWithDefaults(data *apiextensionsv1.JSON) (*metadata.PushSecretMetadata[PushSecretMetadataSpec], error) {
  601. var (
  602. meta *metadata.PushSecretMetadata[PushSecretMetadataSpec]
  603. err error
  604. )
  605. meta, err = metadata.ParseMetadataParameters[PushSecretMetadataSpec](data)
  606. if err != nil {
  607. return nil, fmt.Errorf("failed to parse metadata: %w", err)
  608. }
  609. if meta == nil {
  610. meta = &metadata.PushSecretMetadata[PushSecretMetadataSpec]{}
  611. }
  612. if meta.Spec.SecretPushFormat == "" {
  613. meta.Spec.SecretPushFormat = SecretPushFormatBinary
  614. } else if !slices.Contains([]string{SecretPushFormatBinary, SecretPushFormatString}, meta.Spec.SecretPushFormat) {
  615. return nil, fmt.Errorf("invalid secret push format: %s", meta.Spec.SecretPushFormat)
  616. }
  617. if meta.Spec.Description == "" {
  618. meta.Spec.Description = fmt.Sprintf("secret '%s:%s'", managedBy, externalSecrets)
  619. }
  620. if meta.Spec.KMSKeyID == "" {
  621. meta.Spec.KMSKeyID = "alias/aws/secretsmanager"
  622. }
  623. if len(meta.Spec.Tags) > 0 {
  624. if _, exists := meta.Spec.Tags[managedBy]; exists {
  625. return nil, fmt.Errorf("error parsing tags in metadata: Cannot specify a '%s' tag", managedBy)
  626. }
  627. }
  628. return meta, nil
  629. }