externalsecret_controller.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608
  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. "fmt"
  17. "strings"
  18. "time"
  19. "github.com/go-logr/logr"
  20. v1 "k8s.io/api/core/v1"
  21. "k8s.io/apimachinery/pkg/api/equality"
  22. apierrors "k8s.io/apimachinery/pkg/api/errors"
  23. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  24. "k8s.io/apimachinery/pkg/runtime"
  25. "k8s.io/apimachinery/pkg/types"
  26. "k8s.io/client-go/rest"
  27. "k8s.io/client-go/tools/record"
  28. ctrl "sigs.k8s.io/controller-runtime"
  29. "sigs.k8s.io/controller-runtime/pkg/client"
  30. "sigs.k8s.io/controller-runtime/pkg/controller"
  31. "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
  32. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  33. // Metrics.
  34. "github.com/external-secrets/external-secrets/pkg/controllers/externalsecret/esmetrics"
  35. ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
  36. // Loading registered generators.
  37. _ "github.com/external-secrets/external-secrets/pkg/generator/register"
  38. // Loading registered providers.
  39. _ "github.com/external-secrets/external-secrets/pkg/provider/register"
  40. "github.com/external-secrets/external-secrets/pkg/utils"
  41. )
  42. const (
  43. fieldOwnerTemplate = "externalsecrets.external-secrets.io/%v"
  44. errGetES = "could not get ExternalSecret"
  45. errConvert = "could not apply conversion strategy to keys: %v"
  46. errDecode = "could not apply decoding strategy to %v[%d]: %v"
  47. errGenerate = "could not generate [%d]: %w"
  48. errRewrite = "could not rewrite spec.dataFrom[%d]: %v"
  49. 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)"
  50. errUpdateSecret = "could not update Secret"
  51. errPatchStatus = "unable to patch status"
  52. errStoreRef = "could not get store reference"
  53. errStoreUsability = "could not use store reference"
  54. errStoreProvider = "could not get store provider"
  55. errStoreClient = "could not get provider client"
  56. errGetExistingSecret = "could not get existing secret: %w"
  57. errCloseStoreClient = "could not close provider client"
  58. errSetCtrlReference = "could not set ExternalSecret controller reference: %w"
  59. errFetchTplFrom = "error fetching templateFrom data: %w"
  60. errGetSecretData = "could not get secret data from provider"
  61. errDeleteSecret = "could not delete secret"
  62. errApplyTemplate = "could not apply template: %w"
  63. errExecTpl = "could not execute template: %w"
  64. errInvalidCreatePolicy = "invalid creationPolicy=%s. Can not delete secret i do not own"
  65. errPolicyMergeNotFound = "the desired secret %s was not found. With creationPolicy=Merge the secret won't be created"
  66. errPolicyMergeGetSecret = "unable to get secret %s: %w"
  67. errPolicyMergeMutate = "unable to mutate secret %s: %w"
  68. errPolicyMergePatch = "unable to patch secret %s: %w"
  69. errTplCMMissingKey = "error in configmap %s: missing key %s"
  70. errTplSecMissingKey = "error in secret %s: missing key %s"
  71. )
  72. // Reconciler reconciles a ExternalSecret object.
  73. type Reconciler struct {
  74. client.Client
  75. Log logr.Logger
  76. Scheme *runtime.Scheme
  77. RestConfig *rest.Config
  78. ControllerClass string
  79. RequeueInterval time.Duration
  80. ClusterSecretStoreEnabled bool
  81. EnableFloodGate bool
  82. recorder record.EventRecorder
  83. }
  84. // Reconcile implements the main reconciliation loop
  85. // for watched objects (ExternalSecret, ClusterSecretStore and SecretStore),
  86. // and updates/creates a Kubernetes secret based on them.
  87. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
  88. log := r.Log.WithValues("ExternalSecret", req.NamespacedName)
  89. resourceLabels := ctrlmetrics.RefineNonConditionMetricLabels(map[string]string{"name": req.Name, "namespace": req.Namespace})
  90. start := time.Now()
  91. syncCallsError := esmetrics.GetCounterVec(esmetrics.SyncCallsErrorKey)
  92. // use closures to dynamically update resourceLabels
  93. defer func() {
  94. esmetrics.GetGaugeVec(esmetrics.ExternalSecretReconcileDurationKey).With(resourceLabels).Set(float64(time.Since(start)))
  95. esmetrics.GetCounterVec(esmetrics.SyncCallsKey).With(resourceLabels).Inc()
  96. }()
  97. var externalSecret esv1beta1.ExternalSecret
  98. err := r.Get(ctx, req.NamespacedName, &externalSecret)
  99. if err != nil {
  100. if apierrors.IsNotFound(err) {
  101. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretDeleted, v1.ConditionFalse, esv1beta1.ConditionReasonSecretDeleted, "Secret was deleted")
  102. SetExternalSecretCondition(&esv1beta1.ExternalSecret{
  103. ObjectMeta: metav1.ObjectMeta{
  104. Name: req.Name,
  105. Namespace: req.Namespace,
  106. },
  107. }, *conditionSynced)
  108. return ctrl.Result{}, nil
  109. }
  110. log.Error(err, errGetES)
  111. syncCallsError.With(resourceLabels).Inc()
  112. return ctrl.Result{}, nil
  113. }
  114. // if extended metrics is enabled, refine the time series vector
  115. resourceLabels = ctrlmetrics.RefineLabels(resourceLabels, externalSecret.Labels)
  116. if shouldSkipClusterSecretStore(r, externalSecret) {
  117. log.Info("skipping cluster secret store as it is disabled")
  118. return ctrl.Result{}, nil
  119. }
  120. // skip when pointing to an unmanaged store
  121. skip, err := shouldSkipUnmanagedStore(ctx, req.Namespace, r, externalSecret)
  122. if skip {
  123. log.Info("skipping unmanaged store as it points to a unmanaged controllerClass")
  124. return ctrl.Result{}, nil
  125. }
  126. refreshInt := r.RequeueInterval
  127. if externalSecret.Spec.RefreshInterval != nil {
  128. refreshInt = externalSecret.Spec.RefreshInterval.Duration
  129. }
  130. // Target Secret Name should default to the ExternalSecret name if not explicitly specified
  131. secretName := externalSecret.Spec.Target.Name
  132. if secretName == "" {
  133. secretName = externalSecret.ObjectMeta.Name
  134. }
  135. // fetch external secret, we need to ensure that it exists, and it's hashmap corresponds
  136. var existingSecret v1.Secret
  137. err = r.Get(ctx, types.NamespacedName{
  138. Name: secretName,
  139. Namespace: externalSecret.Namespace,
  140. }, &existingSecret)
  141. if err != nil && !apierrors.IsNotFound(err) {
  142. log.Error(err, errGetExistingSecret)
  143. }
  144. // refresh should be skipped if
  145. // 1. resource generation hasn't changed
  146. // 2. refresh interval is 0
  147. // 3. if we're still within refresh-interval
  148. if !shouldRefresh(externalSecret) && isSecretValid(existingSecret) {
  149. log.V(1).Info("skipping refresh", "rv", getResourceVersion(externalSecret))
  150. return ctrl.Result{RequeueAfter: refreshInt}, nil
  151. }
  152. if !shouldReconcile(externalSecret) {
  153. log.V(1).Info("stopping reconciling", "rv", getResourceVersion(externalSecret))
  154. return ctrl.Result{
  155. RequeueAfter: 0,
  156. Requeue: false,
  157. }, nil
  158. }
  159. // patch status when done processing
  160. p := client.MergeFrom(externalSecret.DeepCopy())
  161. defer func() {
  162. err = r.Status().Patch(ctx, &externalSecret, p)
  163. if err != nil {
  164. log.Error(err, errPatchStatus)
  165. }
  166. }()
  167. secret := &v1.Secret{
  168. ObjectMeta: metav1.ObjectMeta{
  169. Name: secretName,
  170. Namespace: externalSecret.Namespace,
  171. },
  172. Immutable: &externalSecret.Spec.Target.Immutable,
  173. Data: make(map[string][]byte),
  174. }
  175. dataMap, err := r.getProviderSecretData(ctx, &externalSecret)
  176. if err != nil {
  177. log.Error(err, errGetSecretData)
  178. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  179. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errGetSecretData)
  180. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  181. syncCallsError.With(resourceLabels).Inc()
  182. return ctrl.Result{}, err
  183. }
  184. // if no data was found we can delete the secret if needed.
  185. if len(dataMap) == 0 {
  186. switch externalSecret.Spec.Target.DeletionPolicy {
  187. // delete secret and return early.
  188. case esv1beta1.DeletionPolicyDelete:
  189. // safeguard that we only can delete secrets we own
  190. // this is also implemented in the es validation webhook
  191. if externalSecret.Spec.Target.CreationPolicy != esv1beta1.CreatePolicyOwner {
  192. err := fmt.Errorf(errInvalidCreatePolicy, externalSecret.Spec.Target.CreationPolicy)
  193. log.Error(err, errDeleteSecret)
  194. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  195. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  196. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  197. syncCallsError.With(resourceLabels).Inc()
  198. return ctrl.Result{}, err
  199. }
  200. err = r.Delete(ctx, secret)
  201. if err != nil && !apierrors.IsNotFound(err) {
  202. log.Error(err, errDeleteSecret)
  203. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  204. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  205. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  206. syncCallsError.With(resourceLabels).Inc()
  207. }
  208. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretDeleted, "secret deleted due to DeletionPolicy")
  209. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  210. return ctrl.Result{RequeueAfter: refreshInt}, err
  211. case esv1beta1.DeletionPolicyMerge:
  212. // noop, handled below
  213. // In case provider secrets don't exist the kubernetes secret will be kept as-is.
  214. case esv1beta1.DeletionPolicyRetain:
  215. return ctrl.Result{RequeueAfter: refreshInt}, nil
  216. }
  217. }
  218. mutationFunc := func() error {
  219. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  220. err = controllerutil.SetControllerReference(&externalSecret, &secret.ObjectMeta, r.Scheme)
  221. if err != nil {
  222. return fmt.Errorf(errSetCtrlReference, err)
  223. }
  224. }
  225. if secret.Data == nil {
  226. secret.Data = make(map[string][]byte)
  227. }
  228. // diff existing keys
  229. keys, err := getManagedKeys(&existingSecret, externalSecret.Name)
  230. if err != nil {
  231. return err
  232. }
  233. // Sanitize data map for any updates on the ES
  234. for _, key := range keys {
  235. if dataMap[key] == nil {
  236. secret.Data[key] = nil
  237. // Sanitizing any templated / updated keys
  238. delete(secret.Data, key)
  239. }
  240. }
  241. err = r.applyTemplate(ctx, &externalSecret, secret, dataMap)
  242. if err != nil {
  243. return fmt.Errorf(errApplyTemplate, err)
  244. }
  245. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  246. secret.Labels[esv1beta1.LabelOwner] = fmt.Sprintf("%v_%v", externalSecret.Namespace, externalSecret.Name)
  247. }
  248. return nil
  249. }
  250. switch externalSecret.Spec.Target.CreationPolicy { //nolint
  251. case esv1beta1.CreatePolicyMerge:
  252. err = patchSecret(ctx, r.Client, r.Scheme, secret, mutationFunc, externalSecret.Name)
  253. if err == nil {
  254. externalSecret.Status.Binding = v1.LocalObjectReference{Name: secret.Name}
  255. }
  256. case esv1beta1.CreatePolicyNone:
  257. log.V(1).Info("secret creation skipped due to creationPolicy=None")
  258. err = nil
  259. default:
  260. created, err := createOrUpdate(ctx, r.Client, secret, mutationFunc, externalSecret.Name)
  261. if err == nil {
  262. externalSecret.Status.Binding = v1.LocalObjectReference{Name: secret.Name}
  263. }
  264. // cleanup orphaned secrets
  265. if created {
  266. delErr := deleteOrphanedSecrets(ctx, r.Client, &externalSecret)
  267. if delErr != nil {
  268. msg := fmt.Sprintf("failed to clean up orphaned secrets: %v", delErr)
  269. log.Error(err, msg)
  270. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  271. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, msg)
  272. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  273. syncCallsError.With(resourceLabels).Inc()
  274. return ctrl.Result{}, err
  275. }
  276. }
  277. }
  278. if err != nil {
  279. log.Error(err, errUpdateSecret)
  280. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  281. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errUpdateSecret)
  282. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  283. syncCallsError.With(resourceLabels).Inc()
  284. return ctrl.Result{}, err
  285. }
  286. r.recorder.Event(&externalSecret, v1.EventTypeNormal, esv1beta1.ReasonUpdated, "Updated Secret")
  287. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretSynced, "Secret was synced")
  288. currCond := GetExternalSecretCondition(externalSecret.Status, esv1beta1.ExternalSecretReady)
  289. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  290. externalSecret.Status.RefreshTime = metav1.NewTime(time.Now())
  291. externalSecret.Status.SyncedResourceVersion = getResourceVersion(externalSecret)
  292. if currCond == nil || currCond.Status != conditionSynced.Status {
  293. log.Info("reconciled secret") // Log once if on success in any verbosity
  294. } else {
  295. log.V(1).Info("reconciled secret") // Log all reconciliation cycles if higher verbosity applied
  296. }
  297. return ctrl.Result{
  298. RequeueAfter: refreshInt,
  299. }, nil
  300. }
  301. func deleteOrphanedSecrets(ctx context.Context, cl client.Client, externalSecret *esv1beta1.ExternalSecret) error {
  302. secretList := v1.SecretList{}
  303. label := fmt.Sprintf("%v_%v", externalSecret.ObjectMeta.Namespace, externalSecret.ObjectMeta.Name)
  304. ls := &metav1.LabelSelector{
  305. MatchLabels: map[string]string{
  306. esv1beta1.LabelOwner: label,
  307. },
  308. }
  309. labelSelector, err := metav1.LabelSelectorAsSelector(ls)
  310. if err != nil {
  311. return err
  312. }
  313. err = cl.List(ctx, &secretList, &client.ListOptions{LabelSelector: labelSelector})
  314. if err != nil {
  315. return err
  316. }
  317. for key, secret := range secretList.Items {
  318. if externalSecret.Spec.Target.Name != "" && secret.Name != externalSecret.Spec.Target.Name {
  319. err = cl.Delete(ctx, &secretList.Items[key])
  320. if err != nil {
  321. return err
  322. }
  323. }
  324. }
  325. return nil
  326. }
  327. func createOrUpdate(ctx context.Context, c client.Client, obj client.Object, f func() error, fieldOwner string) (bool, error) {
  328. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  329. key := client.ObjectKeyFromObject(obj)
  330. if err := c.Get(ctx, key, obj); err != nil {
  331. if !apierrors.IsNotFound(err) {
  332. return false, err
  333. }
  334. if err := f(); err != nil {
  335. return false, err
  336. }
  337. // Setting Field Owner even for CreationPolicy==Create
  338. if err := c.Create(ctx, obj, client.FieldOwner(fqdn)); err != nil {
  339. return false, err
  340. }
  341. return true, nil
  342. }
  343. existing := obj.DeepCopyObject()
  344. if err := f(); err != nil {
  345. return false, err
  346. }
  347. if equality.Semantic.DeepEqual(existing, obj) {
  348. return false, nil
  349. }
  350. if err := c.Update(ctx, obj, client.FieldOwner(fqdn)); err != nil {
  351. return false, err
  352. }
  353. return false, nil
  354. }
  355. func patchSecret(ctx context.Context, c client.Client, scheme *runtime.Scheme, secret *v1.Secret, mutationFunc func() error, fieldOwner string) error {
  356. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  357. err := c.Get(ctx, client.ObjectKeyFromObject(secret), secret.DeepCopy())
  358. if apierrors.IsNotFound(err) {
  359. return fmt.Errorf(errPolicyMergeNotFound, secret.Name)
  360. }
  361. if err != nil {
  362. return fmt.Errorf(errPolicyMergeGetSecret, secret.Name, err)
  363. }
  364. existing := secret.DeepCopyObject()
  365. err = mutationFunc()
  366. if err != nil {
  367. return fmt.Errorf(errPolicyMergeMutate, secret.Name, err)
  368. }
  369. // GVK is missing in the Secret, see:
  370. // https://github.com/kubernetes-sigs/controller-runtime/issues/526
  371. // https://github.com/kubernetes-sigs/controller-runtime/issues/1517
  372. // https://github.com/kubernetes/kubernetes/issues/80609
  373. // we need to manually set it before doing a Patch() as it depends on the GVK
  374. gvks, unversioned, err := scheme.ObjectKinds(secret)
  375. if err != nil {
  376. return err
  377. }
  378. if !unversioned && len(gvks) == 1 {
  379. secret.SetGroupVersionKind(gvks[0])
  380. }
  381. if equality.Semantic.DeepEqual(existing, secret) {
  382. return nil
  383. }
  384. // Cleaning up Managed fields manually as to keep patch coherence
  385. secret.ObjectMeta.ManagedFields = nil
  386. // we're not able to resolve conflicts so we force ownership
  387. // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#using-server-side-apply-in-a-controller
  388. err = c.Patch(ctx, secret, client.Apply, client.FieldOwner(fqdn), client.ForceOwnership)
  389. if err != nil {
  390. return fmt.Errorf(errPolicyMergePatch, secret.Name, err)
  391. }
  392. return nil
  393. }
  394. func getManagedKeys(secret *v1.Secret, fieldOwner string) ([]string, error) {
  395. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  396. var keys []string
  397. for _, v := range secret.ObjectMeta.ManagedFields {
  398. if v.Manager != fqdn {
  399. continue
  400. }
  401. fields := make(map[string]interface{})
  402. err := json.Unmarshal(v.FieldsV1.Raw, &fields)
  403. if err != nil {
  404. return nil, fmt.Errorf("error unmarshaling managed fields: %w", err)
  405. }
  406. dataFields := fields["f:data"]
  407. if dataFields == nil {
  408. continue
  409. }
  410. df, ok := dataFields.(map[string]interface{})
  411. if !ok {
  412. continue
  413. }
  414. for k := range df {
  415. if k == "." {
  416. continue
  417. }
  418. keys = append(keys, strings.TrimPrefix(k, "f:"))
  419. }
  420. }
  421. return keys, nil
  422. }
  423. func getResourceVersion(es esv1beta1.ExternalSecret) string {
  424. return fmt.Sprintf("%d-%s", es.ObjectMeta.GetGeneration(), hashMeta(es.ObjectMeta))
  425. }
  426. func hashMeta(m metav1.ObjectMeta) string {
  427. type meta struct {
  428. annotations map[string]string
  429. labels map[string]string
  430. }
  431. return utils.ObjectHash(meta{
  432. annotations: m.Annotations,
  433. labels: m.Labels,
  434. })
  435. }
  436. func shouldSkipClusterSecretStore(r *Reconciler, es esv1beta1.ExternalSecret) bool {
  437. return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind
  438. }
  439. // shouldSkipUnmanagedStore iterates over all secretStore references in the externalSecret spec,
  440. // fetches the store and evaluates the controllerClass property.
  441. // Returns true if any storeRef points to store with a non-matching controllerClass.
  442. func shouldSkipUnmanagedStore(ctx context.Context, namespace string, r *Reconciler, es esv1beta1.ExternalSecret) (bool, error) {
  443. var storeList []esv1beta1.SecretStoreRef
  444. if es.Spec.SecretStoreRef.Name != "" {
  445. storeList = append(storeList, es.Spec.SecretStoreRef)
  446. }
  447. for _, ref := range es.Spec.Data {
  448. if ref.SourceRef != nil && ref.SourceRef.SecretStoreRef != nil {
  449. storeList = append(storeList, *ref.SourceRef.SecretStoreRef)
  450. }
  451. }
  452. for _, ref := range es.Spec.DataFrom {
  453. if ref.SourceRef != nil && ref.SourceRef.SecretStoreRef != nil {
  454. storeList = append(storeList, *ref.SourceRef.SecretStoreRef)
  455. }
  456. // verify that generator's controllerClass matches
  457. if ref.SourceRef != nil && ref.SourceRef.GeneratorRef != nil {
  458. genDef, err := r.getGeneratorDefinition(ctx, namespace, ref.SourceRef)
  459. if err != nil {
  460. return false, err
  461. }
  462. skipGenerator, err := shouldSkipGenerator(r, genDef)
  463. if err != nil {
  464. return false, err
  465. }
  466. if skipGenerator {
  467. return true, nil
  468. }
  469. }
  470. }
  471. for _, ref := range storeList {
  472. var store esv1beta1.GenericStore
  473. switch ref.Kind {
  474. case esv1beta1.SecretStoreKind, "":
  475. store = &esv1beta1.SecretStore{}
  476. case esv1beta1.ClusterSecretStoreKind:
  477. store = &esv1beta1.ClusterSecretStore{}
  478. namespace = ""
  479. }
  480. err := r.Client.Get(ctx, types.NamespacedName{
  481. Name: ref.Name,
  482. Namespace: namespace,
  483. }, store)
  484. if err != nil {
  485. return false, err
  486. }
  487. class := store.GetSpec().Controller
  488. if class != "" && class != r.ControllerClass {
  489. return true, nil
  490. }
  491. }
  492. return false, nil
  493. }
  494. func shouldRefresh(es esv1beta1.ExternalSecret) bool {
  495. // refresh if resource version changed
  496. if es.Status.SyncedResourceVersion != getResourceVersion(es) {
  497. return true
  498. }
  499. // skip refresh if refresh interval is 0
  500. if es.Spec.RefreshInterval.Duration == 0 && es.Status.SyncedResourceVersion != "" {
  501. return false
  502. }
  503. if es.Status.RefreshTime.IsZero() {
  504. return true
  505. }
  506. return es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).Before(time.Now())
  507. }
  508. func shouldReconcile(es esv1beta1.ExternalSecret) bool {
  509. if es.Spec.Target.Immutable && hasSyncedCondition(es) {
  510. return false
  511. }
  512. return true
  513. }
  514. func hasSyncedCondition(es esv1beta1.ExternalSecret) bool {
  515. for _, condition := range es.Status.Conditions {
  516. if condition.Reason == "SecretSynced" {
  517. return true
  518. }
  519. }
  520. return false
  521. }
  522. // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash.
  523. func isSecretValid(existingSecret v1.Secret) bool {
  524. // if target secret doesn't exist, or annotations as not set, we need to refresh
  525. if existingSecret.UID == "" || existingSecret.Annotations == nil {
  526. return false
  527. }
  528. // if the calculated hash is different from the calculation, then it's invalid
  529. if existingSecret.Annotations[esv1beta1.AnnotationDataHash] != utils.ObjectHash(existingSecret.Data) {
  530. return false
  531. }
  532. return true
  533. }
  534. // SetupWithManager returns a new controller builder that will be started by the provided Manager.
  535. func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error {
  536. r.recorder = mgr.GetEventRecorderFor("external-secrets")
  537. return ctrl.NewControllerManagedBy(mgr).
  538. WithOptions(opts).
  539. For(&esv1beta1.ExternalSecret{}).
  540. Owns(&v1.Secret{}).
  541. Complete(r)
  542. }