provider.go 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  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 aws
  13. import (
  14. "context"
  15. "fmt"
  16. "time"
  17. "github.com/aws/aws-sdk-go/aws"
  18. awsclient "github.com/aws/aws-sdk-go/aws/client"
  19. "github.com/aws/aws-sdk-go/aws/endpoints"
  20. "github.com/aws/aws-sdk-go/aws/request"
  21. "sigs.k8s.io/controller-runtime/pkg/client"
  22. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  23. awsauth "github.com/external-secrets/external-secrets/pkg/provider/aws/auth"
  24. "github.com/external-secrets/external-secrets/pkg/provider/aws/parameterstore"
  25. "github.com/external-secrets/external-secrets/pkg/provider/aws/secretsmanager"
  26. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  27. "github.com/external-secrets/external-secrets/pkg/utils"
  28. )
  29. // https://github.com/external-secrets/external-secrets/issues/644
  30. var _ esv1beta1.Provider = &Provider{}
  31. // Provider satisfies the provider interface.
  32. type Provider struct{}
  33. const (
  34. errUnableCreateSession = "unable to create session: %w"
  35. errUnknownProviderService = "unknown AWS Provider Service: %s"
  36. errRegionNotFound = "region not found: %s"
  37. errInitAWSProvider = "unable to initialize aws provider: %s"
  38. )
  39. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  40. func (p *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
  41. return esv1beta1.SecretStoreReadWrite
  42. }
  43. // NewClient constructs a new secrets client based on the provided store.
  44. func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string) (esv1beta1.SecretsClient, error) {
  45. return newClient(ctx, store, kube, namespace, awsauth.DefaultSTSProvider)
  46. }
  47. func (p *Provider) ValidateStore(store esv1beta1.GenericStore) error {
  48. prov, err := util.GetAWSProvider(store)
  49. if err != nil {
  50. return err
  51. }
  52. err = validateRegion(prov)
  53. if err != nil {
  54. return err
  55. }
  56. // case: static credentials
  57. if prov.Auth.SecretRef != nil {
  58. if err := utils.ValidateSecretSelector(store, prov.Auth.SecretRef.AccessKeyID); err != nil {
  59. return fmt.Errorf("invalid Auth.SecretRef.AccessKeyID: %w", err)
  60. }
  61. if err := utils.ValidateSecretSelector(store, prov.Auth.SecretRef.SecretAccessKey); err != nil {
  62. return fmt.Errorf("invalid Auth.SecretRef.SecretAccessKey: %w", err)
  63. }
  64. }
  65. // case: jwt credentials
  66. if prov.Auth.JWTAuth != nil && prov.Auth.JWTAuth.ServiceAccountRef != nil {
  67. if err := utils.ValidateServiceAccountSelector(store, *prov.Auth.JWTAuth.ServiceAccountRef); err != nil {
  68. return fmt.Errorf("invalid Auth.JWT.ServiceAccountRef: %w", err)
  69. }
  70. }
  71. return nil
  72. }
  73. func validateRegion(prov *esv1beta1.AWSProvider) error {
  74. resolver := endpoints.DefaultResolver()
  75. partitions := resolver.(endpoints.EnumPartitions).Partitions()
  76. found := false
  77. for _, p := range partitions {
  78. for id := range p.Regions() {
  79. if id == prov.Region {
  80. found = true
  81. }
  82. }
  83. }
  84. if !found {
  85. return fmt.Errorf(errRegionNotFound, prov.Region)
  86. }
  87. return nil
  88. }
  89. func newClient(ctx context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string, assumeRoler awsauth.STSProvider) (esv1beta1.SecretsClient, error) {
  90. prov, err := util.GetAWSProvider(store)
  91. if err != nil {
  92. return nil, err
  93. }
  94. if store == nil {
  95. return nil, fmt.Errorf(errInitAWSProvider, "nil store")
  96. }
  97. storeSpec := store.GetSpec()
  98. var cfg *aws.Config
  99. sess, err := awsauth.New(ctx, store, kube, namespace, assumeRoler, awsauth.DefaultJWTProvider)
  100. if err != nil {
  101. return nil, fmt.Errorf(errUnableCreateSession, err)
  102. }
  103. // Setup retry options, if present in storeSpec
  104. if storeSpec.RetrySettings != nil {
  105. var retryAmount int
  106. var retryDuration time.Duration
  107. if storeSpec.RetrySettings.MaxRetries != nil {
  108. retryAmount = int(*storeSpec.RetrySettings.MaxRetries)
  109. } else {
  110. retryAmount = 3
  111. }
  112. if storeSpec.RetrySettings.RetryInterval != nil {
  113. retryDuration, err = time.ParseDuration(*storeSpec.RetrySettings.RetryInterval)
  114. }
  115. if err != nil {
  116. return nil, fmt.Errorf(errInitAWSProvider, err)
  117. }
  118. awsRetryer := awsclient.DefaultRetryer{
  119. NumMaxRetries: retryAmount,
  120. MinRetryDelay: retryDuration,
  121. MaxThrottleDelay: 120 * time.Second,
  122. }
  123. cfg = request.WithRetryer(aws.NewConfig(), awsRetryer)
  124. }
  125. switch prov.Service {
  126. case esv1beta1.AWSServiceSecretsManager:
  127. return secretsmanager.New(sess, cfg)
  128. case esv1beta1.AWSServiceParameterStore:
  129. return parameterstore.New(sess, cfg)
  130. }
  131. return nil, fmt.Errorf(errUnknownProviderService, prov.Service)
  132. }
  133. func init() {
  134. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  135. AWS: &esv1beta1.AWSProvider{},
  136. })
  137. }