provider.go 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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 doppler
  14. import (
  15. "context"
  16. "errors"
  17. "fmt"
  18. "os"
  19. "strconv"
  20. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  21. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  22. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  23. "github.com/external-secrets/external-secrets/pkg/esutils"
  24. dclient "github.com/external-secrets/external-secrets/pkg/provider/doppler/client"
  25. )
  26. const (
  27. errNewClient = "unable to create DopplerClient : %s"
  28. errInvalidStore = "invalid store: %s"
  29. errDopplerStore = "missing or invalid Doppler SecretStore"
  30. )
  31. // Provider is a Doppler secrets provider implementing NewClient and ValidateStore for the esv1.Provider interface.
  32. type Provider struct{}
  33. // https://github.com/external-secrets/external-secrets/issues/644
  34. var _ esv1.SecretsClient = &Client{}
  35. var _ esv1.Provider = &Provider{}
  36. func init() {
  37. esv1.Register(&Provider{}, &esv1.SecretStoreProvider{
  38. Doppler: &esv1.DopplerProvider{},
  39. }, esv1.MaintenanceStatusMaintained)
  40. }
  41. // Capabilities returns the provider's supported capabilities.
  42. func (p *Provider) Capabilities() esv1.SecretStoreCapabilities {
  43. return esv1.SecretStoreReadOnly
  44. }
  45. // NewClient creates a new Doppler client.
  46. func (p *Provider) NewClient(ctx context.Context, store esv1.GenericStore, kube kclient.Client, namespace string) (esv1.SecretsClient, error) {
  47. storeSpec := store.GetSpec()
  48. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Doppler == nil {
  49. return nil, errors.New(errDopplerStore)
  50. }
  51. dopplerStoreSpec := storeSpec.Provider.Doppler
  52. // Default Key to dopplerToken if not specified
  53. if dopplerStoreSpec.Auth.SecretRef.DopplerToken.Key == "" {
  54. storeSpec.Provider.Doppler.Auth.SecretRef.DopplerToken.Key = "dopplerToken"
  55. }
  56. client := &Client{
  57. kube: kube,
  58. store: dopplerStoreSpec,
  59. namespace: namespace,
  60. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  61. }
  62. if err := client.setAuth(ctx); err != nil {
  63. return nil, err
  64. }
  65. doppler, err := dclient.NewDopplerClient(client.dopplerToken)
  66. if err != nil {
  67. return nil, fmt.Errorf(errNewClient, err)
  68. }
  69. if customBaseURL, found := os.LookupEnv(customBaseURLEnvVar); found {
  70. if err := doppler.SetBaseURL(customBaseURL); err != nil {
  71. return nil, fmt.Errorf(errNewClient, err)
  72. }
  73. }
  74. if customVerifyTLS, found := os.LookupEnv(verifyTLSOverrideEnvVar); found {
  75. customVerifyTLS, err := strconv.ParseBool(customVerifyTLS)
  76. if err == nil {
  77. doppler.VerifyTLS = customVerifyTLS
  78. }
  79. }
  80. client.doppler = doppler
  81. client.project = client.store.Project
  82. client.config = client.store.Config
  83. client.nameTransformer = client.store.NameTransformer
  84. client.format = client.store.Format
  85. return client, nil
  86. }
  87. // ValidateStore validates the Doppler provider configuration.
  88. func (p *Provider) ValidateStore(store esv1.GenericStore) (admission.Warnings, error) {
  89. storeSpec := store.GetSpec()
  90. dopplerStoreSpec := storeSpec.Provider.Doppler
  91. dopplerTokenSecretRef := dopplerStoreSpec.Auth.SecretRef.DopplerToken
  92. if err := esutils.ValidateSecretSelector(store, dopplerTokenSecretRef); err != nil {
  93. return nil, fmt.Errorf(errInvalidStore, err)
  94. }
  95. if dopplerTokenSecretRef.Name == "" {
  96. return nil, fmt.Errorf(errInvalidStore, "dopplerToken.name cannot be empty")
  97. }
  98. return nil, nil
  99. }