provider.go 5.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 aws
  13. import (
  14. "context"
  15. "fmt"
  16. "github.com/aws/aws-sdk-go/aws/session"
  17. v1 "k8s.io/api/core/v1"
  18. ctrl "sigs.k8s.io/controller-runtime"
  19. "sigs.k8s.io/controller-runtime/pkg/client"
  20. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  21. "github.com/external-secrets/external-secrets/pkg/provider"
  22. "github.com/external-secrets/external-secrets/pkg/provider/aws/parameterstore"
  23. "github.com/external-secrets/external-secrets/pkg/provider/aws/secretsmanager"
  24. awssess "github.com/external-secrets/external-secrets/pkg/provider/aws/session"
  25. "github.com/external-secrets/external-secrets/pkg/provider/schema"
  26. )
  27. // Provider satisfies the provider interface.
  28. type Provider struct{}
  29. var log = ctrl.Log.WithName("provider").WithName("aws")
  30. // NewClient constructs a new secrets client based on the provided store.
  31. func (p *Provider) NewClient(ctx context.Context, store esv1alpha1.GenericStore, kube client.Client, namespace string) (provider.SecretsClient, error) {
  32. return newClient(ctx, store, kube, namespace, awssess.DefaultSTSProvider)
  33. }
  34. func newClient(ctx context.Context, store esv1alpha1.GenericStore, kube client.Client, namespace string, assumeRoler awssess.STSProvider) (provider.SecretsClient, error) {
  35. prov, err := getAWSProvider(store)
  36. if err != nil {
  37. return nil, err
  38. }
  39. sess, err := newSession(ctx, store, kube, namespace, assumeRoler)
  40. if err != nil {
  41. return nil, fmt.Errorf("unable to create session: %w", err)
  42. }
  43. switch prov.Service {
  44. case esv1alpha1.AWSServiceSecretsManager:
  45. return secretsmanager.New(sess)
  46. case esv1alpha1.AWSServiceParameterStore:
  47. return parameterstore.New(sess)
  48. }
  49. return nil, fmt.Errorf("unknown AWS Provider Service: %s", prov.Service)
  50. }
  51. // newSession creates a new aws session based on a store
  52. // it looks up credentials at the provided secrets.
  53. func newSession(ctx context.Context, store esv1alpha1.GenericStore, kube client.Client, namespace string, assumeRoler awssess.STSProvider) (*session.Session, error) {
  54. prov, err := getAWSProvider(store)
  55. if err != nil {
  56. return nil, err
  57. }
  58. var sak, aks string
  59. // use provided credentials via secret reference
  60. if prov.Auth != nil {
  61. log.V(1).Info("fetching secrets for authentication")
  62. ke := client.ObjectKey{
  63. Name: prov.Auth.SecretRef.AccessKeyID.Name,
  64. Namespace: namespace, // default to ExternalSecret namespace
  65. }
  66. // only ClusterStore is allowed to set namespace (and then it's required)
  67. if store.GetObjectKind().GroupVersionKind().Kind == esv1alpha1.ClusterSecretStoreKind {
  68. if prov.Auth.SecretRef.AccessKeyID.Namespace == nil {
  69. return nil, fmt.Errorf("invalid ClusterSecretStore: missing AWS AccessKeyID Namespace")
  70. }
  71. ke.Namespace = *prov.Auth.SecretRef.AccessKeyID.Namespace
  72. }
  73. akSecret := v1.Secret{}
  74. err := kube.Get(ctx, ke, &akSecret)
  75. if err != nil {
  76. return nil, fmt.Errorf("could not fetch accessKeyID secret: %w", err)
  77. }
  78. ke = client.ObjectKey{
  79. Name: prov.Auth.SecretRef.SecretAccessKey.Name,
  80. Namespace: namespace, // default to ExternalSecret namespace
  81. }
  82. // only ClusterStore is allowed to set namespace (and then it's required)
  83. if store.GetObjectKind().GroupVersionKind().Kind == esv1alpha1.ClusterSecretStoreKind {
  84. if prov.Auth.SecretRef.SecretAccessKey.Namespace == nil {
  85. return nil, fmt.Errorf("invalid ClusterSecretStore: missing AWS SecretAccessKey Namespace")
  86. }
  87. ke.Namespace = *prov.Auth.SecretRef.SecretAccessKey.Namespace
  88. }
  89. sakSecret := v1.Secret{}
  90. err = kube.Get(ctx, ke, &sakSecret)
  91. if err != nil {
  92. return nil, fmt.Errorf("could not fetch SecretAccessKey secret: %w", err)
  93. }
  94. sak = string(sakSecret.Data[prov.Auth.SecretRef.SecretAccessKey.Key])
  95. aks = string(akSecret.Data[prov.Auth.SecretRef.AccessKeyID.Key])
  96. if sak == "" {
  97. return nil, fmt.Errorf("missing SecretAccessKey")
  98. }
  99. if aks == "" {
  100. return nil, fmt.Errorf("missing AccessKeyID")
  101. }
  102. }
  103. return awssess.New(sak, aks, prov.Region, prov.Role, assumeRoler)
  104. }
  105. // getAWSProvider does the necessary nil checks on the generic store
  106. // it returns the aws provider or an error.
  107. func getAWSProvider(store esv1alpha1.GenericStore) (*esv1alpha1.AWSProvider, error) {
  108. if store == nil {
  109. return nil, fmt.Errorf("found nil store")
  110. }
  111. spc := store.GetSpec()
  112. if spc == nil {
  113. return nil, fmt.Errorf("store is missing spec")
  114. }
  115. if spc.Provider == nil {
  116. return nil, fmt.Errorf("storeSpec is missing provider")
  117. }
  118. prov := spc.Provider.AWS
  119. if prov == nil {
  120. return nil, fmt.Errorf("invalid provider spec. Missing AWS field in store %s", store.GetObjectMeta().String())
  121. }
  122. return prov, nil
  123. }
  124. func init() {
  125. schema.Register(&Provider{}, &esv1alpha1.SecretStoreProvider{
  126. AWS: &esv1alpha1.AWSProvider{},
  127. })
  128. }