provider.go 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  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. )
  57. if err != nil {
  58. return nil, err
  59. }
  60. return &client{
  61. api: smapi.NewAPI(scwClient),
  62. projectID: cfg.ProjectID,
  63. cache: newCache(),
  64. }, nil
  65. }
  66. func loadConfigSecret(ctx context.Context, ref *esv1beta1.ScalewayProviderSecretRef, kube kubeClient.Client, defaultNamespace string) (string, error) {
  67. if ref.SecretRef == nil {
  68. return ref.Value, nil
  69. }
  70. namespace := defaultNamespace
  71. if ref.SecretRef.Namespace != nil {
  72. namespace = *ref.SecretRef.Namespace
  73. }
  74. if ref.SecretRef.Name == "" {
  75. return "", fmt.Errorf("must specify a value or a reference to a secret")
  76. }
  77. if ref.SecretRef.Key == "" {
  78. return "", fmt.Errorf("must specify a secret key")
  79. }
  80. objKey := kubeClient.ObjectKey{
  81. Namespace: namespace,
  82. Name: ref.SecretRef.Name,
  83. }
  84. secret := corev1.Secret{}
  85. err := kube.Get(ctx, objKey, &secret)
  86. if err != nil {
  87. return "", err
  88. }
  89. value, ok := secret.Data[ref.SecretRef.Key]
  90. if !ok {
  91. return "", fmt.Errorf("no such key in secret: %v", ref.SecretRef.Key)
  92. }
  93. return string(value), nil
  94. }
  95. func validateSecretRef(store esv1beta1.GenericStore, ref *esv1beta1.ScalewayProviderSecretRef) error {
  96. if ref.SecretRef != nil {
  97. if ref.Value != "" {
  98. return fmt.Errorf("cannot specify both secret reference and value")
  99. }
  100. err := utils.ValidateReferentSecretSelector(store, *ref.SecretRef)
  101. if err != nil {
  102. return err
  103. }
  104. } else if ref.Value == "" {
  105. return fmt.Errorf("must specify either secret reference or direct value")
  106. }
  107. return nil
  108. }
  109. func doesConfigDependOnNamespace(cfg *esv1beta1.ScalewayProvider) bool {
  110. if cfg.AccessKey.SecretRef != nil && cfg.AccessKey.SecretRef.Namespace == nil {
  111. return true
  112. }
  113. if cfg.SecretKey.SecretRef != nil && cfg.SecretKey.SecretRef.Namespace == nil {
  114. return true
  115. }
  116. return false
  117. }
  118. func getConfig(store esv1beta1.GenericStore) (*esv1beta1.ScalewayProvider, error) {
  119. if store == nil {
  120. return nil, fmt.Errorf("missing store specification")
  121. }
  122. storeSpec := store.GetSpec()
  123. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Scaleway == nil {
  124. return nil, fmt.Errorf("invalid specification for scaleway provider")
  125. }
  126. cfg := storeSpec.Provider.Scaleway
  127. if cfg.APIURL == "" {
  128. cfg.APIURL = defaultAPIURL
  129. } else if !validation.IsURL(cfg.APIURL) {
  130. return nil, fmt.Errorf("invalid api url: %q", cfg.APIURL)
  131. }
  132. if !validation.IsRegion(cfg.Region) {
  133. return nil, fmt.Errorf("invalid region: %q", cfg.Region)
  134. }
  135. if !validation.IsProjectID(cfg.ProjectID) {
  136. return nil, fmt.Errorf("invalid project id: %q", cfg.ProjectID)
  137. }
  138. err := validateSecretRef(store, cfg.AccessKey)
  139. if err != nil {
  140. return nil, err
  141. }
  142. err = validateSecretRef(store, cfg.SecretKey)
  143. if err != nil {
  144. return nil, err
  145. }
  146. return cfg, nil
  147. }
  148. func (p *Provider) ValidateStore(store esv1beta1.GenericStore) error {
  149. _, err := getConfig(store)
  150. return err
  151. }
  152. func init() {
  153. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  154. Scaleway: &esv1beta1.ScalewayProvider{},
  155. })
  156. }