externalsecret_controller.go 22 KB

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