secretsmanager.go 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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. "context"
  15. "encoding/json"
  16. "fmt"
  17. "github.com/aws/aws-sdk-go/aws/session"
  18. awssm "github.com/aws/aws-sdk-go/service/secretsmanager"
  19. "github.com/tidwall/gjson"
  20. ctrl "sigs.k8s.io/controller-runtime"
  21. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  22. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  23. )
  24. // SecretsManager is a provider for AWS SecretsManager.
  25. type SecretsManager struct {
  26. sess *session.Session
  27. client SMInterface
  28. cache map[string]*awssm.GetSecretValueOutput
  29. }
  30. // SMInterface is a subset of the smiface api.
  31. // see: https://docs.aws.amazon.com/sdk-for-go/api/service/secretsmanager/secretsmanageriface/
  32. type SMInterface interface {
  33. GetSecretValue(*awssm.GetSecretValueInput) (*awssm.GetSecretValueOutput, error)
  34. }
  35. var log = ctrl.Log.WithName("provider").WithName("aws").WithName("secretsmanager")
  36. // New creates a new SecretsManager client.
  37. func New(sess *session.Session) (*SecretsManager, error) {
  38. return &SecretsManager{
  39. sess: sess,
  40. client: awssm.New(sess),
  41. cache: make(map[string]*awssm.GetSecretValueOutput),
  42. }, nil
  43. }
  44. func (sm *SecretsManager) fetch(_ context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (*awssm.GetSecretValueOutput, error) {
  45. ver := "AWSCURRENT"
  46. if ref.Version != "" {
  47. ver = ref.Version
  48. }
  49. log.Info("fetching secret value", "key", ref.Key, "version", ver)
  50. cacheKey := fmt.Sprintf("%s#%s", ref.Key, ver)
  51. if secretOut, found := sm.cache[cacheKey]; found {
  52. log.Info("found secret in cache", "key", ref.Key, "version", ver)
  53. return secretOut, nil
  54. }
  55. secretOut, err := sm.client.GetSecretValue(&awssm.GetSecretValueInput{
  56. SecretId: &ref.Key,
  57. VersionStage: &ver,
  58. })
  59. if err != nil {
  60. return nil, err
  61. }
  62. sm.cache[cacheKey] = secretOut
  63. return secretOut, nil
  64. }
  65. // GetSecret returns a single secret from the provider.
  66. func (sm *SecretsManager) GetSecret(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) ([]byte, error) {
  67. secretOut, err := sm.fetch(ctx, ref)
  68. if err != nil {
  69. return nil, util.SanitizeErr(err)
  70. }
  71. if ref.Property == "" {
  72. if secretOut.SecretString != nil {
  73. return []byte(*secretOut.SecretString), nil
  74. }
  75. if secretOut.SecretBinary != nil {
  76. return secretOut.SecretBinary, nil
  77. }
  78. return nil, fmt.Errorf("invalid secret received. no secret string nor binary for key: %s", ref.Key)
  79. }
  80. var payload string
  81. if secretOut.SecretString != nil {
  82. payload = *secretOut.SecretString
  83. }
  84. if secretOut.SecretBinary != nil {
  85. payload = string(secretOut.SecretBinary)
  86. }
  87. val := gjson.Get(payload, ref.Property)
  88. if !val.Exists() {
  89. return nil, fmt.Errorf("key %s does not exist in secret %s", ref.Property, ref.Key)
  90. }
  91. return []byte(val.String()), nil
  92. }
  93. // GetSecretMap returns multiple k/v pairs from the provider.
  94. func (sm *SecretsManager) GetSecretMap(ctx context.Context, ref esv1alpha1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  95. log.Info("fetching secret map", "key", ref.Key)
  96. data, err := sm.GetSecret(ctx, ref)
  97. if err != nil {
  98. return nil, err
  99. }
  100. kv := make(map[string]json.RawMessage)
  101. err = json.Unmarshal(data, &kv)
  102. if err != nil {
  103. return nil, fmt.Errorf("unable to unmarshal secret %s: %w", ref.Key, err)
  104. }
  105. secretData := make(map[string][]byte)
  106. for k, v := range kv {
  107. var strVal string
  108. err = json.Unmarshal(v, &strVal)
  109. if err == nil {
  110. secretData[k] = []byte(strVal)
  111. } else {
  112. secretData[k] = v
  113. }
  114. }
  115. return secretData, nil
  116. }
  117. func (sm *SecretsManager) Close(ctx context.Context) error {
  118. return nil
  119. }
  120. func (sm *SecretsManager) Validate() error {
  121. _, err := sm.sess.Config.Credentials.Get()
  122. return err
  123. }