provider.go 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  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 secretserver
  13. import (
  14. "context"
  15. "errors"
  16. "fmt"
  17. "github.com/DelineaXPM/tss-sdk-go/v2/server"
  18. kubeClient "sigs.k8s.io/controller-runtime/pkg/client"
  19. "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
  20. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  21. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  22. "github.com/external-secrets/external-secrets/pkg/utils"
  23. "github.com/external-secrets/external-secrets/pkg/utils/resolvers"
  24. )
  25. var (
  26. errEmptyUserName = errors.New("username must not be empty")
  27. errEmptyPassword = errors.New("password must be set")
  28. errEmptyServerURL = errors.New("serverURL must be set")
  29. errSecretRefAndValueConflict = errors.New("cannot specify both secret reference and value")
  30. errSecretRefAndValueMissing = errors.New("must specify either secret reference or direct value")
  31. errMissingStore = errors.New("missing store specification")
  32. errInvalidSpec = errors.New("invalid specification for secret server provider")
  33. errClusterStoreRequiresNamespace = errors.New("when using a ClusterSecretStore, namespaces must be explicitly set")
  34. errMissingSecretName = errors.New("must specify a secret name")
  35. errMissingSecretKey = errors.New("must specify a secret key")
  36. )
  37. type Provider struct{}
  38. var _ esv1beta1.Provider = &Provider{}
  39. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  40. func (p *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
  41. return esv1beta1.SecretStoreReadOnly
  42. }
  43. func (p *Provider) ApplyReferent(spec kubeClient.Object, _ esmeta.ReferentCallOrigin, _ string) (kubeClient.Object, error) {
  44. return spec, nil
  45. }
  46. func (p *Provider) Convert(_ esv1beta1.GenericStore) (kubeClient.Object, error) {
  47. return nil, nil
  48. }
  49. func (p *Provider) NewClientFromObj(_ context.Context, _ kubeClient.Object, _ kubeClient.Client, _ string) (esv1beta1.SecretsClient, error) {
  50. return nil, fmt.Errorf("not implemented")
  51. }
  52. func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kubeClient.Client, namespace string) (esv1beta1.SecretsClient, error) {
  53. cfg, err := getConfig(store)
  54. if err != nil {
  55. return nil, err
  56. }
  57. if store.GetKind() == esv1beta1.ClusterSecretStoreKind && doesConfigDependOnNamespace(cfg) {
  58. // we are not attached to a specific namespace, but some config values are dependent on it
  59. return nil, errClusterStoreRequiresNamespace
  60. }
  61. username, err := loadConfigSecret(ctx, store.GetKind(), cfg.Username, kube, namespace)
  62. if err != nil {
  63. return nil, err
  64. }
  65. password, err := loadConfigSecret(ctx, store.GetKind(), cfg.Password, kube, namespace)
  66. if err != nil {
  67. return nil, err
  68. }
  69. secretServer, err := server.New(server.Configuration{
  70. Credentials: server.UserCredential{
  71. Username: username,
  72. Password: password,
  73. },
  74. ServerURL: cfg.ServerURL,
  75. })
  76. if err != nil {
  77. return nil, err
  78. }
  79. return &client{
  80. api: secretServer,
  81. }, nil
  82. }
  83. func loadConfigSecret(
  84. ctx context.Context,
  85. storeKind string,
  86. ref *esv1beta1.SecretServerProviderRef,
  87. kube kubeClient.Client,
  88. namespace string) (string, error) {
  89. if ref.SecretRef == nil {
  90. return ref.Value, nil
  91. }
  92. if err := validateSecretRef(ref); err != nil {
  93. return "", err
  94. }
  95. return resolvers.SecretKeyRef(ctx, kube, storeKind, namespace, ref.SecretRef)
  96. }
  97. func validateStoreSecretRef(store esv1beta1.GenericStore, ref *esv1beta1.SecretServerProviderRef) error {
  98. if ref.SecretRef != nil {
  99. if err := utils.ValidateReferentSecretSelector(store, *ref.SecretRef); err != nil {
  100. return err
  101. }
  102. }
  103. return validateSecretRef(ref)
  104. }
  105. func validateSecretRef(ref *esv1beta1.SecretServerProviderRef) error {
  106. if ref.SecretRef != nil {
  107. if ref.Value != "" {
  108. return errSecretRefAndValueConflict
  109. }
  110. if ref.SecretRef.Name == "" {
  111. return errMissingSecretName
  112. }
  113. if ref.SecretRef.Key == "" {
  114. return errMissingSecretKey
  115. }
  116. } else if ref.Value == "" {
  117. return errSecretRefAndValueMissing
  118. }
  119. return nil
  120. }
  121. func doesConfigDependOnNamespace(cfg *esv1beta1.SecretServerProvider) bool {
  122. if cfg.Username.SecretRef != nil && cfg.Username.SecretRef.Namespace == nil {
  123. return true
  124. }
  125. if cfg.Password.SecretRef != nil && cfg.Password.SecretRef.Namespace == nil {
  126. return true
  127. }
  128. return false
  129. }
  130. func getConfig(store esv1beta1.GenericStore) (*esv1beta1.SecretServerProvider, error) {
  131. if store == nil {
  132. return nil, errMissingStore
  133. }
  134. storeSpec := store.GetSpec()
  135. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.SecretServer == nil {
  136. return nil, errInvalidSpec
  137. }
  138. cfg := storeSpec.Provider.SecretServer
  139. if cfg.Username == nil {
  140. return nil, errEmptyUserName
  141. }
  142. if cfg.Password == nil {
  143. return nil, errEmptyPassword
  144. }
  145. if cfg.ServerURL == "" {
  146. return nil, errEmptyServerURL
  147. }
  148. err := validateStoreSecretRef(store, cfg.Username)
  149. if err != nil {
  150. return nil, err
  151. }
  152. err = validateStoreSecretRef(store, cfg.Password)
  153. if err != nil {
  154. return nil, err
  155. }
  156. return cfg, nil
  157. }
  158. func (p *Provider) ValidateStore(store esv1beta1.GenericStore) (admission.Warnings, error) {
  159. _, err := getConfig(store)
  160. return nil, err
  161. }
  162. func init() {
  163. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  164. SecretServer: &esv1beta1.SecretServerProvider{},
  165. })
  166. }