provider.go 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  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 scaleway
  13. import (
  14. "context"
  15. "fmt"
  16. smapi "github.com/scaleway/scaleway-sdk-go/api/secret/v1alpha1"
  17. "github.com/scaleway/scaleway-sdk-go/scw"
  18. "github.com/scaleway/scaleway-sdk-go/validation"
  19. corev1 "k8s.io/api/core/v1"
  20. ctrl "sigs.k8s.io/controller-runtime"
  21. kubeClient "sigs.k8s.io/controller-runtime/pkg/client"
  22. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  23. "github.com/external-secrets/external-secrets/pkg/utils"
  24. )
  25. var (
  26. defaultAPIURL = "https://api.scaleway.com"
  27. log = ctrl.Log.WithName("provider").WithName("scaleway")
  28. )
  29. type Provider struct{}
  30. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  31. func (p *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
  32. return esv1beta1.SecretStoreReadWrite
  33. }
  34. func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kubeClient.Client, namespace string) (esv1beta1.SecretsClient, error) {
  35. cfg, err := getConfig(store)
  36. if err != nil {
  37. return nil, err
  38. }
  39. if store.GetKind() == esv1beta1.ClusterSecretStoreKind && doesConfigDependOnNamespace(cfg) {
  40. // we are not attached to a specific namespace, but some config values are dependent on it
  41. return nil, fmt.Errorf("when using a ClusterSecretStore, namespaces must be explicitly set")
  42. }
  43. accessKey, err := loadConfigSecret(ctx, cfg.AccessKey, kube, namespace)
  44. if err != nil {
  45. return nil, err
  46. }
  47. secretKey, err := loadConfigSecret(ctx, cfg.SecretKey, kube, namespace)
  48. if err != nil {
  49. return nil, err
  50. }
  51. scwClient, err := scw.NewClient(
  52. scw.WithAPIURL(cfg.APIURL),
  53. scw.WithDefaultRegion(scw.Region(cfg.Region)),
  54. scw.WithDefaultProjectID(cfg.ProjectID),
  55. scw.WithAuth(accessKey, secretKey),
  56. scw.WithUserAgent("external-secrets"),
  57. )
  58. if err != nil {
  59. return nil, err
  60. }
  61. return &client{
  62. api: smapi.NewAPI(scwClient),
  63. projectID: cfg.ProjectID,
  64. cache: newCache(),
  65. }, nil
  66. }
  67. func loadConfigSecret(ctx context.Context, ref *esv1beta1.ScalewayProviderSecretRef, kube kubeClient.Client, defaultNamespace string) (string, error) {
  68. if ref.SecretRef == nil {
  69. return ref.Value, nil
  70. }
  71. namespace := defaultNamespace
  72. if ref.SecretRef.Namespace != nil {
  73. namespace = *ref.SecretRef.Namespace
  74. }
  75. if ref.SecretRef.Name == "" {
  76. return "", fmt.Errorf("must specify a value or a reference to a secret")
  77. }
  78. if ref.SecretRef.Key == "" {
  79. return "", fmt.Errorf("must specify a secret key")
  80. }
  81. objKey := kubeClient.ObjectKey{
  82. Namespace: namespace,
  83. Name: ref.SecretRef.Name,
  84. }
  85. secret := corev1.Secret{}
  86. err := kube.Get(ctx, objKey, &secret)
  87. if err != nil {
  88. return "", err
  89. }
  90. value, ok := secret.Data[ref.SecretRef.Key]
  91. if !ok {
  92. return "", fmt.Errorf("no such key in secret: %v", ref.SecretRef.Key)
  93. }
  94. return string(value), nil
  95. }
  96. func validateSecretRef(store esv1beta1.GenericStore, ref *esv1beta1.ScalewayProviderSecretRef) error {
  97. if ref.SecretRef != nil {
  98. if ref.Value != "" {
  99. return fmt.Errorf("cannot specify both secret reference and value")
  100. }
  101. err := utils.ValidateReferentSecretSelector(store, *ref.SecretRef)
  102. if err != nil {
  103. return err
  104. }
  105. } else if ref.Value == "" {
  106. return fmt.Errorf("must specify either secret reference or direct value")
  107. }
  108. return nil
  109. }
  110. func doesConfigDependOnNamespace(cfg *esv1beta1.ScalewayProvider) bool {
  111. if cfg.AccessKey.SecretRef != nil && cfg.AccessKey.SecretRef.Namespace == nil {
  112. return true
  113. }
  114. if cfg.SecretKey.SecretRef != nil && cfg.SecretKey.SecretRef.Namespace == nil {
  115. return true
  116. }
  117. return false
  118. }
  119. func getConfig(store esv1beta1.GenericStore) (*esv1beta1.ScalewayProvider, error) {
  120. if store == nil {
  121. return nil, fmt.Errorf("missing store specification")
  122. }
  123. storeSpec := store.GetSpec()
  124. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Scaleway == nil {
  125. return nil, fmt.Errorf("invalid specification for scaleway provider")
  126. }
  127. cfg := storeSpec.Provider.Scaleway
  128. if cfg.APIURL == "" {
  129. cfg.APIURL = defaultAPIURL
  130. } else if !validation.IsURL(cfg.APIURL) {
  131. return nil, fmt.Errorf("invalid api url: %q", cfg.APIURL)
  132. }
  133. if !validation.IsRegion(cfg.Region) {
  134. return nil, fmt.Errorf("invalid region: %q", cfg.Region)
  135. }
  136. if !validation.IsProjectID(cfg.ProjectID) {
  137. return nil, fmt.Errorf("invalid project id: %q", cfg.ProjectID)
  138. }
  139. err := validateSecretRef(store, cfg.AccessKey)
  140. if err != nil {
  141. return nil, err
  142. }
  143. err = validateSecretRef(store, cfg.SecretKey)
  144. if err != nil {
  145. return nil, err
  146. }
  147. return cfg, nil
  148. }
  149. func (p *Provider) ValidateStore(store esv1beta1.GenericStore) error {
  150. _, err := getConfig(store)
  151. return err
  152. }
  153. func init() {
  154. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  155. Scaleway: &esv1beta1.ScalewayProvider{},
  156. })
  157. }