externalsecret_controller.go 22 KB

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