provider.go 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  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. // NewClient constructs a new secrets client based on the provided store.
  40. func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string) (esv1beta1.SecretsClient, error) {
  41. return newClient(ctx, store, kube, namespace, awsauth.DefaultSTSProvider)
  42. }
  43. func (p *Provider) ValidateStore(store esv1beta1.GenericStore) error {
  44. prov, err := util.GetAWSProvider(store)
  45. if err != nil {
  46. return err
  47. }
  48. err = validateRegion(prov)
  49. if err != nil {
  50. return err
  51. }
  52. // case: static credentials
  53. if prov.Auth.SecretRef != nil {
  54. if err := utils.ValidateSecretSelector(store, prov.Auth.SecretRef.AccessKeyID); err != nil {
  55. return fmt.Errorf("invalid Auth.SecretRef.AccessKeyID: %w", err)
  56. }
  57. if err := utils.ValidateSecretSelector(store, prov.Auth.SecretRef.SecretAccessKey); err != nil {
  58. return fmt.Errorf("invalid Auth.SecretRef.SecretAccessKey: %w", err)
  59. }
  60. }
  61. // case: jwt credentials
  62. if prov.Auth.JWTAuth != nil && prov.Auth.JWTAuth.ServiceAccountRef != nil {
  63. if err := utils.ValidateServiceAccountSelector(store, *prov.Auth.JWTAuth.ServiceAccountRef); err != nil {
  64. return fmt.Errorf("invalid Auth.JWT.ServiceAccountRef: %w", err)
  65. }
  66. }
  67. return nil
  68. }
  69. func validateRegion(prov *esv1beta1.AWSProvider) error {
  70. resolver := endpoints.DefaultResolver()
  71. partitions := resolver.(endpoints.EnumPartitions).Partitions()
  72. found := false
  73. for _, p := range partitions {
  74. for id := range p.Regions() {
  75. if id == prov.Region {
  76. found = true
  77. }
  78. }
  79. }
  80. if !found {
  81. return fmt.Errorf(errRegionNotFound, prov.Region)
  82. }
  83. return nil
  84. }
  85. func newClient(ctx context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string, assumeRoler awsauth.STSProvider) (esv1beta1.SecretsClient, error) {
  86. prov, err := util.GetAWSProvider(store)
  87. if err != nil {
  88. return nil, err
  89. }
  90. if store == nil {
  91. return nil, fmt.Errorf(errInitAWSProvider, "nil store")
  92. }
  93. storeSpec := store.GetSpec()
  94. var cfg *aws.Config
  95. sess, err := awsauth.New(ctx, store, kube, namespace, assumeRoler, awsauth.DefaultJWTProvider)
  96. if err != nil {
  97. return nil, fmt.Errorf(errUnableCreateSession, err)
  98. }
  99. // Setup retry options, if present in storeSpec
  100. if storeSpec.RetrySettings != nil {
  101. var retryAmount int
  102. var retryDuration time.Duration
  103. if storeSpec.RetrySettings.MaxRetries != nil {
  104. retryAmount = int(*storeSpec.RetrySettings.MaxRetries)
  105. } else {
  106. retryAmount = 3
  107. }
  108. if storeSpec.RetrySettings.RetryInterval != nil {
  109. retryDuration, err = time.ParseDuration(*storeSpec.RetrySettings.RetryInterval)
  110. }
  111. if err != nil {
  112. return nil, fmt.Errorf(errInitAWSProvider, err)
  113. }
  114. awsRetryer := awsclient.DefaultRetryer{
  115. NumMaxRetries: retryAmount,
  116. MinRetryDelay: retryDuration,
  117. MaxThrottleDelay: 120 * time.Second,
  118. }
  119. cfg = request.WithRetryer(aws.NewConfig(), awsRetryer)
  120. }
  121. switch prov.Service {
  122. case esv1beta1.AWSServiceSecretsManager:
  123. return secretsmanager.New(sess, cfg)
  124. case esv1beta1.AWSServiceParameterStore:
  125. return parameterstore.New(sess, cfg)
  126. }
  127. return nil, fmt.Errorf(errUnknownProviderService, prov.Service)
  128. }
  129. func init() {
  130. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  131. AWS: &esv1beta1.AWSProvider{},
  132. })
  133. }