provider.go 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  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 kubernetes
  13. import (
  14. "context"
  15. "errors"
  16. "fmt"
  17. authv1 "k8s.io/api/authorization/v1"
  18. v1 "k8s.io/api/core/v1"
  19. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  20. "k8s.io/client-go/kubernetes"
  21. typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
  22. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  23. ctrlcfg "sigs.k8s.io/controller-runtime/pkg/client/config"
  24. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  25. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  26. )
  27. // https://github.com/external-secrets/external-secrets/issues/644
  28. var _ esv1beta1.SecretsClient = &Client{}
  29. var _ esv1beta1.Provider = &Provider{}
  30. type KClient interface {
  31. Get(ctx context.Context, name string, opts metav1.GetOptions) (*v1.Secret, error)
  32. List(ctx context.Context, opts metav1.ListOptions) (*v1.SecretList, error)
  33. Delete(ctx context.Context, name string, opts metav1.DeleteOptions) error
  34. Create(ctx context.Context, secret *v1.Secret, opts metav1.CreateOptions) (*v1.Secret, error)
  35. Update(ctx context.Context, secret *v1.Secret, opts metav1.UpdateOptions) (*v1.Secret, error)
  36. }
  37. type RClient interface {
  38. Create(ctx context.Context, selfSubjectRulesReview *authv1.SelfSubjectRulesReview, opts metav1.CreateOptions) (*authv1.SelfSubjectRulesReview, error)
  39. }
  40. // Provider implements Secret Provider interface
  41. // for Kubernetes.
  42. type Provider struct{}
  43. // Client implements Secret Client interface
  44. // for Kubernetes.
  45. type Client struct {
  46. // ctrlClient is a controller-runtime client
  47. // with RBAC scope of the controller (privileged!)
  48. ctrlClient kclient.Client
  49. // ctrlClientset is a client-go CoreV1() client
  50. // with RBAC scope of the controller (privileged!)
  51. ctrlClientset typedcorev1.CoreV1Interface
  52. // userSecretClient is a client-go CoreV1().Secrets() client
  53. // with user-defined scope.
  54. userSecretClient KClient
  55. // userReviewClient is a SelfSubjectAccessReview client with
  56. // user-defined scope.
  57. userReviewClient RClient
  58. // store is the Kubernetes Provider spec
  59. // which contains the configuration for this provider.
  60. store *esv1beta1.KubernetesProvider
  61. storeKind string
  62. // namespace is the namespace of the
  63. // ExternalSecret referencing this provider.
  64. namespace string
  65. }
  66. func init() {
  67. esv1beta1.Register(&Provider{}, &esv1beta1.SecretStoreProvider{
  68. Kubernetes: &esv1beta1.KubernetesProvider{},
  69. })
  70. }
  71. func (p *Provider) Capabilities() esv1beta1.SecretStoreCapabilities {
  72. return esv1beta1.SecretStoreReadWrite
  73. }
  74. func (p *Provider) Convert(_ esv1beta1.GenericStore) (kclient.Object, error) {
  75. return nil, nil
  76. }
  77. func (p *Provider) ApplyReferent(spec kclient.Object, _ esmeta.ReferentCallOrigin, _ string) (kclient.Object, error) {
  78. return spec, nil
  79. }
  80. func (p *Provider) NewClientFromObj(_ context.Context, _ kclient.Object, _ kclient.Client, _ string) (esv1beta1.SecretsClient, error) {
  81. return nil, fmt.Errorf("not implemented")
  82. }
  83. // NewClient constructs a Kubernetes Provider.
  84. func (p *Provider) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, namespace string) (esv1beta1.SecretsClient, error) {
  85. restCfg, err := ctrlcfg.GetConfig()
  86. if err != nil {
  87. return nil, err
  88. }
  89. clientset, err := kubernetes.NewForConfig(restCfg)
  90. if err != nil {
  91. return nil, err
  92. }
  93. return p.newClient(ctx, store, kube, clientset, namespace)
  94. }
  95. func (p *Provider) newClient(ctx context.Context, store esv1beta1.GenericStore, ctrlClient kclient.Client, ctrlClientset kubernetes.Interface, namespace string) (esv1beta1.SecretsClient, error) {
  96. storeSpec := store.GetSpec()
  97. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Kubernetes == nil {
  98. return nil, errors.New("no store type or wrong store type")
  99. }
  100. storeSpecKubernetes := storeSpec.Provider.Kubernetes
  101. client := &Client{
  102. ctrlClientset: ctrlClientset.CoreV1(),
  103. ctrlClient: ctrlClient,
  104. store: storeSpecKubernetes,
  105. namespace: namespace,
  106. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  107. }
  108. // allow SecretStore controller validation to pass
  109. // when using referent namespace.
  110. if client.storeKind == esv1beta1.ClusterSecretStoreKind && client.namespace == "" && isReferentSpec(storeSpecKubernetes) {
  111. return client, nil
  112. }
  113. cfg, err := client.getAuth(ctx)
  114. if err != nil {
  115. return nil, fmt.Errorf("failed to prepare auth: %w", err)
  116. }
  117. userClientset, err := kubernetes.NewForConfig(cfg)
  118. if err != nil {
  119. return nil, fmt.Errorf("error configuring clientset: %w", err)
  120. }
  121. client.userSecretClient = userClientset.CoreV1().Secrets(client.store.RemoteNamespace)
  122. client.userReviewClient = userClientset.AuthorizationV1().SelfSubjectRulesReviews()
  123. return client, nil
  124. }
  125. func isReferentSpec(prov *esv1beta1.KubernetesProvider) bool {
  126. if prov.Auth.Cert != nil {
  127. if prov.Auth.Cert.ClientCert.Namespace == nil {
  128. return true
  129. }
  130. if prov.Auth.Cert.ClientKey.Namespace == nil {
  131. return true
  132. }
  133. }
  134. if prov.Auth.ServiceAccount != nil {
  135. if prov.Auth.ServiceAccount.Namespace == nil {
  136. return true
  137. }
  138. }
  139. if prov.Auth.Token != nil {
  140. if prov.Auth.Token.BearerToken.Namespace == nil {
  141. return true
  142. }
  143. }
  144. return false
  145. }
  146. func (p *Provider) Close(_ context.Context) error {
  147. return nil
  148. }