externalsecret_controller.go 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714
  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 externalsecret
  13. import (
  14. "context"
  15. "encoding/json"
  16. "errors"
  17. "fmt"
  18. "strings"
  19. "time"
  20. "github.com/go-logr/logr"
  21. "github.com/prometheus/client_golang/prometheus"
  22. v1 "k8s.io/api/core/v1"
  23. apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  24. "k8s.io/apimachinery/pkg/api/equality"
  25. apierrors "k8s.io/apimachinery/pkg/api/errors"
  26. "k8s.io/apimachinery/pkg/runtime/schema"
  27. "k8s.io/client-go/discovery"
  28. "k8s.io/client-go/dynamic"
  29. "k8s.io/client-go/rest"
  30. "k8s.io/client-go/restmapper"
  31. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  32. "k8s.io/apimachinery/pkg/runtime"
  33. "k8s.io/apimachinery/pkg/types"
  34. "k8s.io/client-go/tools/record"
  35. ctrl "sigs.k8s.io/controller-runtime"
  36. "sigs.k8s.io/controller-runtime/pkg/builder"
  37. "sigs.k8s.io/controller-runtime/pkg/client"
  38. "sigs.k8s.io/controller-runtime/pkg/controller"
  39. "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
  40. "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  41. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  42. genv1alpha1 "github.com/external-secrets/external-secrets/apis/generators/v1alpha1"
  43. "github.com/external-secrets/external-secrets/pkg/controllers/secretstore"
  44. // Loading registered generators.
  45. _ "github.com/external-secrets/external-secrets/pkg/generator/register"
  46. // Loading registered providers.
  47. _ "github.com/external-secrets/external-secrets/pkg/provider/register"
  48. "github.com/external-secrets/external-secrets/pkg/utils"
  49. )
  50. const (
  51. requeueAfter = time.Second * 30
  52. fieldOwnerTemplate = "externalsecrets.external-secrets.io/%v"
  53. errGetES = "could not get ExternalSecret"
  54. errConvert = "could not apply conversion strategy to keys: %v"
  55. errDecode = "could not apply decoding strategy to %v[%d]: %v"
  56. errGenerate = "could not generate [%d]: %w"
  57. errRewrite = "could not rewrite spec.dataFrom[%d]: %v"
  58. errInvalidKeys = "secret keys from spec.dataFrom.%v[%d] can only have alphanumeric,'-', '_' or '.' characters. Convert them using rewrite (https://external-secrets.io/latest/guides-datafrom-rewrite)"
  59. errUpdateSecret = "could not update Secret"
  60. errPatchStatus = "unable to patch status"
  61. errGetSecretStore = "could not get SecretStore %q, %w"
  62. errSecretStoreNotReady = "the desired SecretStore %s is not ready"
  63. errGetClusterSecretStore = "could not get ClusterSecretStore %q, %w"
  64. errStoreRef = "could not get store reference"
  65. errStoreUsability = "could not use store reference"
  66. errStoreProvider = "could not get store provider"
  67. errStoreClient = "could not get provider client"
  68. errGetExistingSecret = "could not get existing secret: %w"
  69. errCloseStoreClient = "could not close provider client"
  70. errSetCtrlReference = "could not set ExternalSecret controller reference: %w"
  71. errFetchTplFrom = "error fetching templateFrom data: %w"
  72. errGetSecretData = "could not get secret data from provider"
  73. errDeleteSecret = "could not delete secret"
  74. errApplyTemplate = "could not apply template: %w"
  75. errExecTpl = "could not execute template: %w"
  76. errInvalidCreatePolicy = "invalid creationPolicy=%s. Can not delete secret i do not own"
  77. errPolicyMergeNotFound = "the desired secret %s was not found. With creationPolicy=Merge the secret won't be created"
  78. errPolicyMergeGetSecret = "unable to get secret %s: %w"
  79. errPolicyMergeMutate = "unable to mutate secret %s: %w"
  80. errPolicyMergePatch = "unable to patch secret %s: %w"
  81. errTplCMMissingKey = "error in configmap %s: missing key %s"
  82. errTplSecMissingKey = "error in secret %s: missing key %s"
  83. )
  84. // Reconciler reconciles a ExternalSecret object.
  85. type Reconciler struct {
  86. client.Client
  87. Log logr.Logger
  88. Scheme *runtime.Scheme
  89. RestConfig *rest.Config
  90. ControllerClass string
  91. RequeueInterval time.Duration
  92. ClusterSecretStoreEnabled bool
  93. EnableFloodGate bool
  94. recorder record.EventRecorder
  95. }
  96. // Reconcile implements the main reconciliation loop
  97. // for watched objects (ExternalSecret, ClusterSecretStore and SecretStore),
  98. // and updates/creates a Kubernetes secret based on them.
  99. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
  100. log := r.Log.WithValues("ExternalSecret", req.NamespacedName)
  101. syncCallsMetricLabels := prometheus.Labels{"name": req.Name, "namespace": req.Namespace}
  102. var externalSecret esv1beta1.ExternalSecret
  103. err := r.Get(ctx, req.NamespacedName, &externalSecret)
  104. if apierrors.IsNotFound(err) {
  105. syncCallsTotal.With(syncCallsMetricLabels).Inc()
  106. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretDeleted, v1.ConditionFalse, esv1beta1.ConditionReasonSecretDeleted, "Secret was deleted")
  107. SetExternalSecretCondition(&esv1beta1.ExternalSecret{
  108. ObjectMeta: metav1.ObjectMeta{
  109. Name: req.Name,
  110. Namespace: req.Namespace,
  111. },
  112. }, *conditionSynced)
  113. return ctrl.Result{}, nil
  114. } else if err != nil {
  115. log.Error(err, errGetES)
  116. syncCallsError.With(syncCallsMetricLabels).Inc()
  117. return ctrl.Result{}, nil
  118. }
  119. if shouldSkipClusterSecretStore(r, externalSecret) {
  120. log.Info("skipping cluster secret store as it is disabled")
  121. return ctrl.Result{}, nil
  122. }
  123. // patch status when done processing
  124. p := client.MergeFrom(externalSecret.DeepCopy())
  125. defer func() {
  126. err = r.Status().Patch(ctx, &externalSecret, p)
  127. if err != nil {
  128. log.Error(err, errPatchStatus)
  129. }
  130. }()
  131. refreshInt := r.RequeueInterval
  132. if externalSecret.Spec.RefreshInterval != nil {
  133. refreshInt = externalSecret.Spec.RefreshInterval.Duration
  134. }
  135. // Target Secret Name should default to the ExternalSecret name if not explicitly specified
  136. secretName := externalSecret.Spec.Target.Name
  137. if secretName == "" {
  138. secretName = externalSecret.ObjectMeta.Name
  139. }
  140. // fetch external secret, we need to ensure that it exists, and it's hashmap corresponds
  141. var existingSecret v1.Secret
  142. err = r.Get(ctx, types.NamespacedName{
  143. Name: secretName,
  144. Namespace: externalSecret.Namespace,
  145. }, &existingSecret)
  146. if err != nil && !apierrors.IsNotFound(err) {
  147. log.Error(err, errGetExistingSecret)
  148. }
  149. // refresh should be skipped if
  150. // 1. resource generation hasn't changed
  151. // 2. refresh interval is 0
  152. // 3. if we're still within refresh-interval
  153. if !shouldRefresh(externalSecret) && isSecretValid(existingSecret) {
  154. log.V(1).Info("skipping refresh", "rv", getResourceVersion(externalSecret))
  155. return ctrl.Result{RequeueAfter: refreshInt}, nil
  156. }
  157. if !shouldReconcile(externalSecret) {
  158. log.V(1).Info("stopping reconciling", "rv", getResourceVersion(externalSecret))
  159. return ctrl.Result{
  160. RequeueAfter: 0,
  161. Requeue: false,
  162. }, nil
  163. }
  164. secret := &v1.Secret{
  165. ObjectMeta: metav1.ObjectMeta{
  166. Name: secretName,
  167. Namespace: externalSecret.Namespace,
  168. },
  169. Immutable: &externalSecret.Spec.Target.Immutable,
  170. Data: make(map[string][]byte),
  171. }
  172. dataMap, err := r.getProviderSecretData(ctx, &externalSecret, r.Client)
  173. if err != nil {
  174. log.Error(err, errGetSecretData)
  175. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  176. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errGetSecretData)
  177. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  178. syncCallsError.With(syncCallsMetricLabels).Inc()
  179. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  180. }
  181. // if no data was found we can delete the secret if needed.
  182. if len(dataMap) == 0 {
  183. switch externalSecret.Spec.Target.DeletionPolicy {
  184. // delete secret and return early.
  185. case esv1beta1.DeletionPolicyDelete:
  186. // safeguard that we only can delete secrets we own
  187. // this is also implemented in the es validation webhook
  188. if externalSecret.Spec.Target.CreationPolicy != esv1beta1.CreatePolicyOwner {
  189. err := fmt.Errorf(errInvalidCreatePolicy, externalSecret.Spec.Target.CreationPolicy)
  190. log.Error(err, errDeleteSecret)
  191. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  192. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  193. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  194. syncCallsError.With(syncCallsMetricLabels).Inc()
  195. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  196. }
  197. err = r.Delete(ctx, secret)
  198. if err != nil && !apierrors.IsNotFound(err) {
  199. log.Error(err, errDeleteSecret)
  200. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  201. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  202. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  203. syncCallsError.With(syncCallsMetricLabels).Inc()
  204. }
  205. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretDeleted, "secret deleted due to DeletionPolicy")
  206. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  207. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  208. case esv1beta1.DeletionPolicyMerge:
  209. // noop, handled below
  210. // In case provider secrets don't exist the kubernetes secret will be kept as-is.
  211. case esv1beta1.DeletionPolicyRetain:
  212. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  213. }
  214. }
  215. mutationFunc := func() error {
  216. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  217. err = controllerutil.SetControllerReference(&externalSecret, &secret.ObjectMeta, r.Scheme)
  218. if err != nil {
  219. return fmt.Errorf(errSetCtrlReference, err)
  220. }
  221. }
  222. if secret.Data == nil {
  223. secret.Data = make(map[string][]byte)
  224. }
  225. err = r.applyTemplate(ctx, &externalSecret, secret, dataMap)
  226. if err != nil {
  227. return fmt.Errorf(errApplyTemplate, err)
  228. }
  229. // diff existing keys
  230. if externalSecret.Spec.Target.DeletionPolicy == esv1beta1.DeletionPolicyMerge {
  231. keys, err := getManagedKeys(&existingSecret, externalSecret.Name)
  232. if err != nil {
  233. return err
  234. }
  235. for _, key := range keys {
  236. if dataMap[key] == nil {
  237. secret.Data[key] = nil
  238. }
  239. }
  240. }
  241. return nil
  242. }
  243. //nolint
  244. switch externalSecret.Spec.Target.CreationPolicy {
  245. case esv1beta1.CreatePolicyMerge:
  246. err = patchSecret(ctx, r.Client, r.Scheme, secret, mutationFunc, externalSecret.Name)
  247. case esv1beta1.CreatePolicyNone:
  248. log.V(1).Info("secret creation skipped due to creationPolicy=None")
  249. err = nil
  250. default:
  251. _, err = ctrl.CreateOrUpdate(ctx, r.Client, secret, mutationFunc)
  252. }
  253. if err != nil {
  254. log.Error(err, errUpdateSecret)
  255. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  256. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errUpdateSecret)
  257. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  258. syncCallsError.With(syncCallsMetricLabels).Inc()
  259. return ctrl.Result{}, err
  260. }
  261. r.recorder.Event(&externalSecret, v1.EventTypeNormal, esv1beta1.ReasonUpdated, "Updated Secret")
  262. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretSynced, "Secret was synced")
  263. currCond := GetExternalSecretCondition(externalSecret.Status, esv1beta1.ExternalSecretReady)
  264. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  265. externalSecret.Status.RefreshTime = metav1.NewTime(time.Now())
  266. externalSecret.Status.SyncedResourceVersion = getResourceVersion(externalSecret)
  267. syncCallsTotal.With(syncCallsMetricLabels).Inc()
  268. if currCond == nil || currCond.Status != conditionSynced.Status {
  269. log.Info("reconciled secret") // Log once if on success in any verbosity
  270. } else {
  271. log.V(1).Info("reconciled secret") // Log all reconciliation cycles if higher verbosity applied
  272. }
  273. return ctrl.Result{
  274. RequeueAfter: refreshInt,
  275. }, nil
  276. }
  277. func patchSecret(ctx context.Context, c client.Client, scheme *runtime.Scheme, secret *v1.Secret, mutationFunc func() error, fieldOwner string) error {
  278. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  279. err := c.Get(ctx, client.ObjectKeyFromObject(secret), secret.DeepCopy())
  280. if apierrors.IsNotFound(err) {
  281. return fmt.Errorf(errPolicyMergeNotFound, secret.Name)
  282. }
  283. if err != nil {
  284. return fmt.Errorf(errPolicyMergeGetSecret, secret.Name, err)
  285. }
  286. existing := secret.DeepCopyObject()
  287. err = mutationFunc()
  288. if err != nil {
  289. return fmt.Errorf(errPolicyMergeMutate, secret.Name, err)
  290. }
  291. // GVK is missing in the Secret, see:
  292. // https://github.com/kubernetes-sigs/controller-runtime/issues/526
  293. // https://github.com/kubernetes-sigs/controller-runtime/issues/1517
  294. // https://github.com/kubernetes/kubernetes/issues/80609
  295. // we need to manually set it before doing a Patch() as it depends on the GVK
  296. gvks, unversioned, err := scheme.ObjectKinds(secret)
  297. if err != nil {
  298. return err
  299. }
  300. if !unversioned && len(gvks) == 1 {
  301. secret.SetGroupVersionKind(gvks[0])
  302. }
  303. if equality.Semantic.DeepEqual(existing, secret) {
  304. return nil
  305. }
  306. // we're not able to resolve conflicts so we force ownership
  307. // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#using-server-side-apply-in-a-controller
  308. err = c.Patch(ctx, secret, client.Apply, client.FieldOwner(fqdn), client.ForceOwnership)
  309. if err != nil {
  310. return fmt.Errorf(errPolicyMergePatch, secret.Name, err)
  311. }
  312. return nil
  313. }
  314. func getManagedKeys(secret *v1.Secret, fieldOwner string) ([]string, error) {
  315. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  316. var keys []string
  317. for _, v := range secret.ObjectMeta.ManagedFields {
  318. if v.Manager != fqdn {
  319. continue
  320. }
  321. fields := make(map[string]interface{})
  322. err := json.Unmarshal(v.FieldsV1.Raw, &fields)
  323. if err != nil {
  324. return nil, fmt.Errorf("error unmarshaling managed fields: %w", err)
  325. }
  326. dataFields := fields["f:data"]
  327. if dataFields == nil {
  328. continue
  329. }
  330. df, ok := dataFields.(map[string]string)
  331. if !ok {
  332. continue
  333. }
  334. for k := range df {
  335. if k == "." {
  336. continue
  337. }
  338. keys = append(keys, strings.TrimPrefix(k, "f:"))
  339. }
  340. }
  341. return keys, nil
  342. }
  343. func getResourceVersion(es esv1beta1.ExternalSecret) string {
  344. return fmt.Sprintf("%d-%s", es.ObjectMeta.GetGeneration(), hashMeta(es.ObjectMeta))
  345. }
  346. func hashMeta(m metav1.ObjectMeta) string {
  347. type meta struct {
  348. annotations map[string]string
  349. labels map[string]string
  350. }
  351. return utils.ObjectHash(meta{
  352. annotations: m.Annotations,
  353. labels: m.Labels,
  354. })
  355. }
  356. func shouldSkipClusterSecretStore(r *Reconciler, es esv1beta1.ExternalSecret) bool {
  357. return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind
  358. }
  359. func shouldRefresh(es esv1beta1.ExternalSecret) bool {
  360. // refresh if resource version changed
  361. if es.Status.SyncedResourceVersion != getResourceVersion(es) {
  362. return true
  363. }
  364. // skip refresh if refresh interval is 0
  365. if es.Spec.RefreshInterval.Duration == 0 && es.Status.SyncedResourceVersion != "" {
  366. return false
  367. }
  368. if es.Status.RefreshTime.IsZero() {
  369. return true
  370. }
  371. return es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).Before(time.Now())
  372. }
  373. func shouldReconcile(es esv1beta1.ExternalSecret) bool {
  374. if es.Spec.Target.Immutable && hasSyncedCondition(es) {
  375. return false
  376. }
  377. return true
  378. }
  379. func hasSyncedCondition(es esv1beta1.ExternalSecret) bool {
  380. for _, condition := range es.Status.Conditions {
  381. if condition.Reason == "SecretSynced" {
  382. return true
  383. }
  384. }
  385. return false
  386. }
  387. // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash.
  388. func isSecretValid(existingSecret v1.Secret) bool {
  389. // if target secret doesn't exist, or annotations as not set, we need to refresh
  390. if existingSecret.UID == "" || existingSecret.Annotations == nil {
  391. return false
  392. }
  393. // if the calculated hash is different from the calculation, then it's invalid
  394. if existingSecret.Annotations[esv1beta1.AnnotationDataHash] != utils.ObjectHash(existingSecret.Data) {
  395. return false
  396. }
  397. return true
  398. }
  399. // assertStoreIsUsable assert that the store is ready to use.
  400. func assertStoreIsUsable(store esv1beta1.GenericStore) error {
  401. if store == nil {
  402. return nil
  403. }
  404. condition := secretstore.GetSecretStoreCondition(store.GetStatus(), esv1beta1.SecretStoreReady)
  405. if condition == nil || condition.Status != v1.ConditionTrue {
  406. return fmt.Errorf(errSecretStoreNotReady, store.GetName())
  407. }
  408. return nil
  409. }
  410. func (r *Reconciler) getStore(ctx context.Context, storeRef *esv1beta1.SecretStoreRef, namespace string) (esv1beta1.GenericStore, error) {
  411. ref := types.NamespacedName{
  412. Name: storeRef.Name,
  413. }
  414. if storeRef.Kind == esv1beta1.ClusterSecretStoreKind {
  415. var store esv1beta1.ClusterSecretStore
  416. err := r.Get(ctx, ref, &store)
  417. if err != nil {
  418. return nil, fmt.Errorf(errGetClusterSecretStore, ref.Name, err)
  419. }
  420. return &store, nil
  421. }
  422. ref.Namespace = namespace
  423. var store esv1beta1.SecretStore
  424. err := r.Get(ctx, ref, &store)
  425. if err != nil {
  426. return nil, fmt.Errorf(errGetSecretStore, ref.Name, err)
  427. }
  428. return &store, nil
  429. }
  430. // getProviderSecretData returns the provider's secret data with the provided ExternalSecret.
  431. func (r *Reconciler) getProviderSecretData(ctx context.Context, externalSecret *esv1beta1.ExternalSecret, crClient client.Client) (map[string][]byte, error) {
  432. providerData := make(map[string][]byte)
  433. for i, remoteRef := range externalSecret.Spec.DataFrom {
  434. var secretMap map[string][]byte
  435. var err error
  436. if remoteRef.Find != nil {
  437. secretMap, err = r.handleFindAllSecrets(ctx, externalSecret, remoteRef, i)
  438. } else if remoteRef.Extract != nil {
  439. secretMap, err = r.handleExtractSecrets(ctx, externalSecret, remoteRef, i)
  440. } else if remoteRef.SourceRef != nil && (remoteRef.SourceRef.Generator != nil || remoteRef.SourceRef.GeneratorRef != nil) {
  441. secretMap, err = r.handleGenerateSecrets(ctx, externalSecret.Namespace, remoteRef, i)
  442. }
  443. if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain {
  444. r.recorder.Event(
  445. externalSecret,
  446. v1.EventTypeNormal,
  447. esv1beta1.ReasonDeleted,
  448. fmt.Sprintf("secret does not exist at provider using .dataFrom[%d]", i),
  449. )
  450. continue
  451. }
  452. if err != nil {
  453. return nil, err
  454. }
  455. providerData = utils.MergeByteMap(providerData, secretMap)
  456. }
  457. for i, secretRef := range externalSecret.Spec.Data {
  458. client, err := r.getClientOrDefault(ctx, externalSecret.Spec.SecretStoreRef, externalSecret.Namespace, secretRef.SourceRef)
  459. if err != nil {
  460. return nil, err
  461. }
  462. defer client.Close(ctx)
  463. secretData, err := client.GetSecret(ctx, secretRef.RemoteRef)
  464. if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain {
  465. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonDeleted, fmt.Sprintf("secret does not exist at provider using .data[%d] key=%s", i, secretRef.RemoteRef.Key))
  466. continue
  467. }
  468. if err != nil {
  469. return nil, err
  470. }
  471. secretData, err = utils.Decode(secretRef.RemoteRef.DecodingStrategy, secretData)
  472. if err != nil {
  473. return nil, fmt.Errorf(errDecode, "spec.data", i, err)
  474. }
  475. providerData[secretRef.SecretKey] = secretData
  476. }
  477. return providerData, nil
  478. }
  479. func (r *Reconciler) handleGenerateSecrets(ctx context.Context, namespace string, remoteRef esv1beta1.ExternalSecretDataFromRemoteRef, i int) (map[string][]byte, error) {
  480. genDef, err := r.getGeneratorDefinition(ctx, namespace, remoteRef.SourceRef)
  481. if err != nil {
  482. return nil, err
  483. }
  484. gen, err := genv1alpha1.GetGenerator(genDef)
  485. if err != nil {
  486. return nil, err
  487. }
  488. secretMap, err := gen.Generate(ctx, genDef, r.Client, namespace)
  489. if err != nil {
  490. return nil, fmt.Errorf(errGenerate, i, err)
  491. }
  492. secretMap, err = utils.RewriteMap(remoteRef.Rewrite, secretMap)
  493. if err != nil {
  494. return nil, fmt.Errorf(errRewrite, i, err)
  495. }
  496. if !utils.ValidateKeys(secretMap) {
  497. return nil, fmt.Errorf(errInvalidKeys, "generator", i)
  498. }
  499. return secretMap, err
  500. }
  501. // getGeneratorDefinition returns the generator JSON for a given sourceRef
  502. // when a generator is defined inline it returns sourceRef.Generator straight away
  503. // when it uses a generatorRef it fetches the resource and returns the JSON
  504. func (r *Reconciler) getGeneratorDefinition(ctx context.Context, namespace string, sourceRef *esv1beta1.SourceRef) (*apiextensions.JSON, error) {
  505. if sourceRef.Generator != nil {
  506. return sourceRef.Generator, nil
  507. }
  508. // client-go dynamic client needs a GVR to fetch the resource
  509. // But we only have the GVK in our generatorRef.
  510. //
  511. // TODO: there is no need to discover the GroupVersionResource
  512. // this should be cached.
  513. c := discovery.NewDiscoveryClientForConfigOrDie(r.RestConfig)
  514. groupResources, err := restmapper.GetAPIGroupResources(c)
  515. if err != nil {
  516. return nil, err
  517. }
  518. gv, err := schema.ParseGroupVersion(sourceRef.GeneratorRef.APIVersion)
  519. if err != nil {
  520. return nil, err
  521. }
  522. mapper := restmapper.NewDiscoveryRESTMapper(groupResources)
  523. mapping, err := mapper.RESTMapping(schema.GroupKind{
  524. Group: gv.Group,
  525. Kind: sourceRef.GeneratorRef.Kind,
  526. })
  527. if err != nil {
  528. return nil, err
  529. }
  530. d, err := dynamic.NewForConfig(r.RestConfig)
  531. if err != nil {
  532. return nil, err
  533. }
  534. res, err := d.Resource(mapping.Resource).
  535. Namespace(namespace).
  536. Get(ctx, sourceRef.GeneratorRef.Name, metav1.GetOptions{})
  537. if err != nil {
  538. return nil, err
  539. }
  540. jsonRes, err := res.MarshalJSON()
  541. if err != nil {
  542. return nil, err
  543. }
  544. return &apiextensions.JSON{Raw: jsonRes}, nil
  545. }
  546. func (r *Reconciler) handleExtractSecrets(ctx context.Context, externalSecret *esv1beta1.ExternalSecret, remoteRef esv1beta1.ExternalSecretDataFromRemoteRef, i int) (map[string][]byte, error) {
  547. client, err := r.getClientOrDefault(ctx, externalSecret.Spec.SecretStoreRef, externalSecret.Namespace, remoteRef.SourceRef)
  548. if err != nil {
  549. return nil, err
  550. }
  551. defer client.Close(ctx)
  552. secretMap, err := client.GetSecretMap(ctx, *remoteRef.Extract)
  553. if err != nil {
  554. return nil, err
  555. }
  556. secretMap, err = utils.RewriteMap(remoteRef.Rewrite, secretMap)
  557. if err != nil {
  558. return nil, fmt.Errorf(errRewrite, i, err)
  559. }
  560. if len(remoteRef.Rewrite) == 0 {
  561. secretMap, err = utils.ConvertKeys(remoteRef.Extract.ConversionStrategy, secretMap)
  562. if err != nil {
  563. return nil, fmt.Errorf(errConvert, err)
  564. }
  565. }
  566. if !utils.ValidateKeys(secretMap) {
  567. return nil, fmt.Errorf(errInvalidKeys, "extract", i)
  568. }
  569. secretMap, err = utils.DecodeMap(remoteRef.Extract.DecodingStrategy, secretMap)
  570. if err != nil {
  571. return nil, fmt.Errorf(errDecode, "spec.dataFrom", i, err)
  572. }
  573. return secretMap, err
  574. }
  575. func (r *Reconciler) handleFindAllSecrets(ctx context.Context, externalSecret *esv1beta1.ExternalSecret, remoteRef esv1beta1.ExternalSecretDataFromRemoteRef, i int) (map[string][]byte, error) {
  576. client, err := r.getClientOrDefault(ctx, externalSecret.Spec.SecretStoreRef, externalSecret.Namespace, remoteRef.SourceRef)
  577. if err != nil {
  578. return nil, err
  579. }
  580. defer client.Close(ctx)
  581. secretMap, err := client.GetAllSecrets(ctx, *remoteRef.Find)
  582. if err != nil {
  583. return nil, err
  584. }
  585. secretMap, err = utils.RewriteMap(remoteRef.Rewrite, secretMap)
  586. if err != nil {
  587. return nil, fmt.Errorf(errRewrite, i, err)
  588. }
  589. if len(remoteRef.Rewrite) == 0 {
  590. // ConversionStrategy is deprecated. Use RewriteMap instead.
  591. r.recorder.Event(externalSecret, v1.EventTypeWarning, esv1beta1.ReasonDeprecated, fmt.Sprintf("dataFrom[%d].find.conversionStrategy=%v is deprecated and will be removed in further releases. Use dataFrom.rewrite instead", i, remoteRef.Find.ConversionStrategy))
  592. secretMap, err = utils.ConvertKeys(remoteRef.Find.ConversionStrategy, secretMap)
  593. if err != nil {
  594. return nil, fmt.Errorf(errConvert, err)
  595. }
  596. }
  597. if !utils.ValidateKeys(secretMap) {
  598. return nil, fmt.Errorf(errInvalidKeys, "find", i)
  599. }
  600. secretMap, err = utils.DecodeMap(remoteRef.Find.DecodingStrategy, secretMap)
  601. if err != nil {
  602. return nil, fmt.Errorf(errDecode, "spec.dataFrom", i, err)
  603. }
  604. return secretMap, err
  605. }
  606. // getClientOrDefault returns a provider client from the given storeRef or sourceRef.secretStoreRef
  607. // while sourceRef.SecretStoreRef takes precedence over storeRef.
  608. // it returns nil if both storeRef and sourceRef.secretStoreRef is empty
  609. func (r *Reconciler) getClientOrDefault(ctx context.Context, storeRef esv1beta1.SecretStoreRef, namespace string, sourceRef *esv1beta1.SourceRef) (v1beta1.SecretsClient, error) {
  610. if sourceRef != nil && sourceRef.SecretStoreRef != nil {
  611. storeRef = *sourceRef.SecretStoreRef
  612. }
  613. store, err := r.getStore(ctx, &storeRef, namespace)
  614. if err != nil {
  615. return nil, err
  616. }
  617. // check if store should be handled by this controller instance
  618. if !secretstore.ShouldProcessStore(store, r.ControllerClass) {
  619. return nil, fmt.Errorf("can not reference unmanaged store")
  620. }
  621. if r.EnableFloodGate {
  622. if err = assertStoreIsUsable(store); err != nil {
  623. return nil, err
  624. }
  625. }
  626. storeProvider, err := esv1beta1.GetProvider(store)
  627. if err != nil {
  628. return nil, err
  629. }
  630. // secret client is created only if we are going to refresh
  631. // this skip an unnecessary check/request in the case we are not going to do anything
  632. providerClient, err := storeProvider.NewClient(ctx, store, r.Client, namespace)
  633. if err != nil {
  634. return nil, err
  635. }
  636. return providerClient, nil
  637. }
  638. // SetupWithManager returns a new controller builder that will be started by the provided Manager.
  639. func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error {
  640. r.recorder = mgr.GetEventRecorderFor("external-secrets")
  641. return ctrl.NewControllerManagedBy(mgr).
  642. WithOptions(opts).
  643. For(&esv1beta1.ExternalSecret{}).
  644. Owns(&v1.Secret{}, builder.OnlyMetadata).
  645. Complete(r)
  646. }