provider.go 5.3 KB

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