provider.go 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package scaleway
  14. import (
  15. "context"
  16. "errors"
  17. "fmt"
  18. smapi "github.com/scaleway/scaleway-sdk-go/api/secret/v1beta1"
  19. "github.com/scaleway/scaleway-sdk-go/scw"
  20. "github.com/scaleway/scaleway-sdk-go/validation"
  21. ctrl "sigs.k8s.io/controller-runtime"
  22. kubeClient "sigs.k8s.io/controller-runtime/pkg/client"
  23. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  24. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  25. "github.com/external-secrets/external-secrets/pkg/utils"
  26. "github.com/external-secrets/external-secrets/pkg/utils/resolvers"
  27. )
  28. var (
  29. defaultAPIURL = "https://api.scaleway.com"
  30. log = ctrl.Log.WithName("provider").WithName("scaleway")
  31. )
  32. type Provider struct{}
  33. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  34. func (p *Provider) Capabilities() esv1.SecretStoreCapabilities {
  35. return esv1.SecretStoreReadWrite
  36. }
  37. func (p *Provider) NewClient(ctx context.Context, store esv1.GenericStore, kube kubeClient.Client, namespace string) (esv1.SecretsClient, error) {
  38. cfg, err := getConfig(store)
  39. if err != nil {
  40. return nil, err
  41. }
  42. if store.GetKind() == esv1.ClusterSecretStoreKind && doesConfigDependOnNamespace(cfg) {
  43. // we are not attached to a specific namespace, but some config values are dependent on it
  44. return nil, errors.New("when using a ClusterSecretStore, namespaces must be explicitly set")
  45. }
  46. accessKey, err := loadConfigSecret(ctx, cfg.AccessKey, kube, namespace, store.GetKind())
  47. if err != nil {
  48. return nil, err
  49. }
  50. secretKey, err := loadConfigSecret(ctx, cfg.SecretKey, kube, namespace, store.GetKind())
  51. if err != nil {
  52. return nil, err
  53. }
  54. scwClient, err := scw.NewClient(
  55. scw.WithAPIURL(cfg.APIURL),
  56. scw.WithDefaultRegion(scw.Region(cfg.Region)),
  57. scw.WithDefaultProjectID(cfg.ProjectID),
  58. scw.WithAuth(accessKey, secretKey),
  59. scw.WithUserAgent("external-secrets"),
  60. )
  61. if err != nil {
  62. return nil, err
  63. }
  64. return &client{
  65. api: smapi.NewAPI(scwClient),
  66. projectID: cfg.ProjectID,
  67. cache: newCache(),
  68. }, nil
  69. }
  70. func loadConfigSecret(ctx context.Context, ref *esv1.ScalewayProviderSecretRef, kube kubeClient.Client, defaultNamespace, storeKind string) (string, error) {
  71. if ref.SecretRef == nil {
  72. return ref.Value, nil
  73. }
  74. return resolvers.SecretKeyRef(
  75. ctx,
  76. kube,
  77. storeKind,
  78. defaultNamespace,
  79. ref.SecretRef,
  80. )
  81. }
  82. func validateSecretRef(store esv1.GenericStore, ref *esv1.ScalewayProviderSecretRef) error {
  83. if ref.SecretRef != nil {
  84. if ref.Value != "" {
  85. return errors.New("cannot specify both secret reference and value")
  86. }
  87. err := utils.ValidateReferentSecretSelector(store, *ref.SecretRef)
  88. if err != nil {
  89. return err
  90. }
  91. } else if ref.Value == "" {
  92. return errors.New("must specify either secret reference or direct value")
  93. }
  94. return nil
  95. }
  96. func doesConfigDependOnNamespace(cfg *esv1.ScalewayProvider) bool {
  97. if cfg.AccessKey.SecretRef != nil && cfg.AccessKey.SecretRef.Namespace == nil {
  98. return true
  99. }
  100. if cfg.SecretKey.SecretRef != nil && cfg.SecretKey.SecretRef.Namespace == nil {
  101. return true
  102. }
  103. return false
  104. }
  105. func getConfig(store esv1.GenericStore) (*esv1.ScalewayProvider, error) {
  106. if store == nil {
  107. return nil, errors.New("missing store specification")
  108. }
  109. storeSpec := store.GetSpec()
  110. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Scaleway == nil {
  111. return nil, errors.New("invalid specification for scaleway provider")
  112. }
  113. cfg := storeSpec.Provider.Scaleway
  114. if cfg.APIURL == "" {
  115. cfg.APIURL = defaultAPIURL
  116. } else if !validation.IsURL(cfg.APIURL) {
  117. return nil, fmt.Errorf("invalid api url: %q", cfg.APIURL)
  118. }
  119. if !validation.IsRegion(cfg.Region) {
  120. return nil, fmt.Errorf("invalid region: %q", cfg.Region)
  121. }
  122. if !validation.IsProjectID(cfg.ProjectID) {
  123. return nil, fmt.Errorf("invalid project id: %q", cfg.ProjectID)
  124. }
  125. err := validateSecretRef(store, cfg.AccessKey)
  126. if err != nil {
  127. return nil, err
  128. }
  129. err = validateSecretRef(store, cfg.SecretKey)
  130. if err != nil {
  131. return nil, err
  132. }
  133. return cfg, nil
  134. }
  135. func (p *Provider) ValidateStore(store esv1.GenericStore) (admission.Warnings, error) {
  136. _, err := getConfig(store)
  137. return nil, err
  138. }
  139. func init() {
  140. esv1.Register(&Provider{}, &esv1.SecretStoreProvider{
  141. Scaleway: &esv1.ScalewayProvider{},
  142. }, esv1.MaintenanceStatusMaintained)
  143. }