externalsecret_controller.go 22 KB

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