kubernetes.go 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  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. corev1 "k8s.io/api/core/v1"
  17. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  18. "k8s.io/apimachinery/pkg/types"
  19. "k8s.io/client-go/kubernetes"
  20. "k8s.io/client-go/rest"
  21. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  22. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  23. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  24. "github.com/external-secrets/external-secrets/pkg/provider"
  25. "github.com/external-secrets/external-secrets/pkg/provider/schema"
  26. "github.com/external-secrets/external-secrets/pkg/utils"
  27. )
  28. const (
  29. errPropertyNotFound = "property field not found on extrenal secrets"
  30. errKubernetesCredSecretName = "kubernetes credentials are empty"
  31. errInvalidClusterStoreMissingNamespace = "invalid clusterStore missing Cert namespace"
  32. errFetchCredentialsSecret = "could not fetch Credentials secret: %w"
  33. errMissingCredentials = "missing Credentials: %v"
  34. errUninitalizedKubernetesProvider = "provider kubernetes is not initialized"
  35. errEmptyKey = "key %s found but empty"
  36. )
  37. type KClient interface {
  38. Get(ctx context.Context, name string, opts metav1.GetOptions) (*corev1.Secret, error)
  39. }
  40. // ProviderKubernetes is a provider for Kubernetes.
  41. type ProviderKubernetes struct {
  42. Client KClient
  43. }
  44. var _ provider.SecretsClient = &ProviderKubernetes{}
  45. type BaseClient struct {
  46. kube kclient.Client
  47. store *esv1beta1.KubernetesProvider
  48. namespace string
  49. storeKind string
  50. Certificate []byte
  51. Key []byte
  52. CA []byte
  53. BearerToken []byte
  54. }
  55. func init() {
  56. schema.Register(&ProviderKubernetes{}, &esv1beta1.SecretStoreProvider{
  57. Kubernetes: &esv1beta1.KubernetesProvider{},
  58. })
  59. }
  60. // NewClient constructs a Kubernetes Provider.
  61. func (k *ProviderKubernetes) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube kclient.Client, namespace string) (provider.SecretsClient, error) {
  62. storeSpec := store.GetSpec()
  63. if storeSpec == nil || storeSpec.Provider == nil || storeSpec.Provider.Kubernetes == nil {
  64. return nil, fmt.Errorf("no store type or wrong store type")
  65. }
  66. storeSpecKubernetes := storeSpec.Provider.Kubernetes
  67. bStore := BaseClient{
  68. kube: kube,
  69. store: storeSpecKubernetes,
  70. namespace: namespace,
  71. storeKind: store.GetObjectKind().GroupVersionKind().Kind,
  72. }
  73. if err := bStore.setAuth(ctx); err != nil {
  74. return nil, err
  75. }
  76. config := &rest.Config{
  77. Host: bStore.store.Server.URL,
  78. BearerToken: string(bStore.BearerToken),
  79. TLSClientConfig: rest.TLSClientConfig{
  80. Insecure: false,
  81. CertData: bStore.Certificate,
  82. KeyData: bStore.Key,
  83. CAData: bStore.CA,
  84. },
  85. }
  86. kubeClientSet, err := kubernetes.NewForConfig(config)
  87. if err != nil {
  88. return nil, fmt.Errorf("error configuring clientset: %w", err)
  89. }
  90. k.Client = kubeClientSet.CoreV1().Secrets(bStore.store.RemoteNamespace)
  91. return k, nil
  92. }
  93. func (k *ProviderKubernetes) Close(ctx context.Context) error {
  94. return nil
  95. }
  96. func (k *ProviderKubernetes) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  97. if ref.Property == "" {
  98. return nil, fmt.Errorf(errPropertyNotFound)
  99. }
  100. payload, err := k.GetSecretMap(ctx, ref)
  101. if err != nil {
  102. return nil, err
  103. }
  104. val, ok := payload[ref.Property]
  105. if !ok {
  106. return nil, fmt.Errorf("property %s does not exist in key %s", ref.Property, ref.Key)
  107. }
  108. return val, nil
  109. }
  110. func (k *ProviderKubernetes) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  111. if utils.IsNil(k.Client) {
  112. return nil, fmt.Errorf(errUninitalizedKubernetesProvider)
  113. }
  114. opts := metav1.GetOptions{}
  115. secretOut, err := k.Client.Get(ctx, ref.Key, opts)
  116. if err != nil {
  117. return nil, err
  118. }
  119. var payload map[string][]byte
  120. if len(secretOut.Data) != 0 {
  121. payload = secretOut.Data
  122. }
  123. return payload, nil
  124. }
  125. func (k *ProviderKubernetes) GetAllSecrets(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  126. return nil, fmt.Errorf("not implemented")
  127. }
  128. func (k *BaseClient) setAuth(ctx context.Context) error {
  129. var err error
  130. if len(k.store.Server.CABundle) > 0 {
  131. k.CA = k.store.Server.CABundle
  132. } else if k.store.Server.CAProvider != nil {
  133. keySelector := esmeta.SecretKeySelector{
  134. Name: k.store.Server.CAProvider.Name,
  135. Namespace: k.store.Server.CAProvider.Namespace,
  136. Key: k.store.Server.CAProvider.Key,
  137. }
  138. k.CA, err = k.fetchSecretKey(ctx, keySelector, "CA")
  139. if err != nil {
  140. return err
  141. }
  142. } else {
  143. return fmt.Errorf("no Certificate Authority provided")
  144. }
  145. if k.store.Auth.Token != nil {
  146. k.BearerToken, err = k.fetchSecretKey(ctx, k.store.Auth.Token.BearerToken, "bearerToken")
  147. if err != nil {
  148. return err
  149. }
  150. } else if k.store.Auth.ServiceAccount != nil {
  151. return fmt.Errorf("not implemented yet")
  152. } else if k.store.Auth.Cert != nil {
  153. k.Certificate, err = k.fetchSecretKey(ctx, k.store.Auth.Cert.ClientCert, "cert")
  154. if err != nil {
  155. return err
  156. }
  157. k.Key, err = k.fetchSecretKey(ctx, k.store.Auth.Cert.ClientKey, "key")
  158. if err != nil {
  159. return err
  160. }
  161. } else {
  162. return fmt.Errorf("no credentials provided")
  163. }
  164. return nil
  165. }
  166. func (k *BaseClient) fetchSecretKey(ctx context.Context, key esmeta.SecretKeySelector, component string) ([]byte, error) {
  167. keySecret := &corev1.Secret{}
  168. keySecretName := key.Name
  169. if keySecretName == "" {
  170. return nil, fmt.Errorf(errKubernetesCredSecretName)
  171. }
  172. objectKey := types.NamespacedName{
  173. Name: keySecretName,
  174. Namespace: k.namespace,
  175. }
  176. // only ClusterStore is allowed to set namespace (and then it's required)
  177. if k.storeKind == esv1beta1.ClusterSecretStoreKind {
  178. if key.Namespace == nil {
  179. return nil, fmt.Errorf(errInvalidClusterStoreMissingNamespace)
  180. }
  181. objectKey.Namespace = *key.Namespace
  182. }
  183. err := k.kube.Get(ctx, objectKey, keySecret)
  184. if err != nil {
  185. return nil, fmt.Errorf(errFetchCredentialsSecret, err)
  186. }
  187. val, ok := keySecret.Data[key.Key]
  188. if !ok {
  189. return nil, fmt.Errorf(errMissingCredentials, component)
  190. }
  191. if len(val) == 0 {
  192. return nil, fmt.Errorf(errEmptyKey, component)
  193. }
  194. return val, nil
  195. }
  196. func (k *ProviderKubernetes) Validate() error {
  197. return nil
  198. }