provider.go 5.1 KB

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