externalsecret_controller.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  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{}, err
  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. return ctrl.Result{}, err
  145. }
  146. // refresh should be skipped if
  147. // 1. resource generation hasn't changed
  148. // 2. refresh interval is 0
  149. // 3. if we're still within refresh-interval
  150. if !shouldRefresh(externalSecret) && isSecretValid(existingSecret) {
  151. log.V(1).Info("skipping refresh", "rv", getResourceVersion(externalSecret))
  152. return ctrl.Result{RequeueAfter: refreshInt}, nil
  153. }
  154. if !shouldReconcile(externalSecret) {
  155. log.V(1).Info("stopping reconciling", "rv", getResourceVersion(externalSecret))
  156. return ctrl.Result{
  157. RequeueAfter: 0,
  158. Requeue: false,
  159. }, nil
  160. }
  161. // patch status when done processing
  162. p := client.MergeFrom(externalSecret.DeepCopy())
  163. defer func() {
  164. err = r.Status().Patch(ctx, &externalSecret, p)
  165. if err != nil {
  166. log.Error(err, errPatchStatus)
  167. }
  168. }()
  169. secret := &v1.Secret{
  170. ObjectMeta: metav1.ObjectMeta{
  171. Name: secretName,
  172. Namespace: externalSecret.Namespace,
  173. },
  174. Immutable: &externalSecret.Spec.Target.Immutable,
  175. Data: make(map[string][]byte),
  176. }
  177. dataMap, err := r.getProviderSecretData(ctx, &externalSecret)
  178. if err != nil {
  179. log.Error(err, errGetSecretData)
  180. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  181. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errGetSecretData)
  182. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  183. syncCallsError.With(resourceLabels).Inc()
  184. return ctrl.Result{}, err
  185. }
  186. // if no data was found we can delete the secret if needed.
  187. if len(dataMap) == 0 {
  188. switch externalSecret.Spec.Target.DeletionPolicy {
  189. // delete secret and return early.
  190. case esv1beta1.DeletionPolicyDelete:
  191. // safeguard that we only can delete secrets we own
  192. // this is also implemented in the es validation webhook
  193. if externalSecret.Spec.Target.CreationPolicy != esv1beta1.CreatePolicyOwner {
  194. err := fmt.Errorf(errInvalidCreatePolicy, externalSecret.Spec.Target.CreationPolicy)
  195. log.Error(err, errDeleteSecret)
  196. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  197. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  198. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  199. syncCallsError.With(resourceLabels).Inc()
  200. return ctrl.Result{}, err
  201. }
  202. err = r.Delete(ctx, secret)
  203. if err != nil && !apierrors.IsNotFound(err) {
  204. log.Error(err, errDeleteSecret)
  205. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  206. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  207. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  208. syncCallsError.With(resourceLabels).Inc()
  209. }
  210. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretDeleted, "secret deleted due to DeletionPolicy")
  211. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  212. return ctrl.Result{RequeueAfter: refreshInt}, err
  213. case esv1beta1.DeletionPolicyMerge:
  214. // noop, handled below
  215. // In case provider secrets don't exist the kubernetes secret will be kept as-is.
  216. case esv1beta1.DeletionPolicyRetain:
  217. return ctrl.Result{RequeueAfter: refreshInt}, nil
  218. }
  219. }
  220. mutationFunc := func() error {
  221. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  222. err = controllerutil.SetControllerReference(&externalSecret, &secret.ObjectMeta, r.Scheme)
  223. if err != nil {
  224. return fmt.Errorf(errSetCtrlReference, err)
  225. }
  226. }
  227. if secret.Data == nil {
  228. secret.Data = make(map[string][]byte)
  229. }
  230. // diff existing keys
  231. keys, err := getManagedKeys(&existingSecret, externalSecret.Name)
  232. if err != nil {
  233. return err
  234. }
  235. // Sanitize data map for any updates on the ES
  236. for _, key := range keys {
  237. if dataMap[key] == nil {
  238. secret.Data[key] = nil
  239. // Sanitizing any templated / updated keys
  240. delete(secret.Data, key)
  241. }
  242. }
  243. err = r.applyTemplate(ctx, &externalSecret, secret, dataMap)
  244. if err != nil {
  245. return fmt.Errorf(errApplyTemplate, err)
  246. }
  247. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  248. lblValue := utils.ObjectHash(fmt.Sprintf("%v/%v", externalSecret.Namespace, externalSecret.Name))
  249. secret.Labels[esv1beta1.LabelOwner] = lblValue
  250. }
  251. secret.Annotations[esv1beta1.AnnotationDataHash] = r.computeDataHashAnnotation(&existingSecret, secret)
  252. return nil
  253. }
  254. switch externalSecret.Spec.Target.CreationPolicy { //nolint
  255. case esv1beta1.CreatePolicyMerge:
  256. err = patchSecret(ctx, r.Client, r.Scheme, secret, mutationFunc, externalSecret.Name)
  257. if err == nil {
  258. externalSecret.Status.Binding = v1.LocalObjectReference{Name: secret.Name}
  259. }
  260. case esv1beta1.CreatePolicyNone:
  261. log.V(1).Info("secret creation skipped due to creationPolicy=None")
  262. err = nil
  263. default:
  264. var created bool
  265. created, err = createOrUpdate(ctx, r.Client, secret, mutationFunc, externalSecret.Name)
  266. if err == nil {
  267. externalSecret.Status.Binding = v1.LocalObjectReference{Name: secret.Name}
  268. }
  269. // cleanup orphaned secrets
  270. if created {
  271. delErr := deleteOrphanedSecrets(ctx, r.Client, &externalSecret)
  272. if delErr != nil {
  273. msg := fmt.Sprintf("failed to clean up orphaned secrets: %v", delErr)
  274. log.Error(delErr, msg)
  275. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, delErr.Error())
  276. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, msg)
  277. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  278. syncCallsError.With(resourceLabels).Inc()
  279. return ctrl.Result{}, delErr
  280. }
  281. }
  282. }
  283. if err != nil {
  284. log.Error(err, errUpdateSecret)
  285. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  286. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errUpdateSecret)
  287. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  288. syncCallsError.With(resourceLabels).Inc()
  289. return ctrl.Result{}, err
  290. }
  291. r.recorder.Event(&externalSecret, v1.EventTypeNormal, esv1beta1.ReasonUpdated, "Updated Secret")
  292. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretSynced, "Secret was synced")
  293. currCond := GetExternalSecretCondition(externalSecret.Status, esv1beta1.ExternalSecretReady)
  294. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  295. externalSecret.Status.RefreshTime = metav1.NewTime(time.Now())
  296. externalSecret.Status.SyncedResourceVersion = getResourceVersion(externalSecret)
  297. if currCond == nil || currCond.Status != conditionSynced.Status {
  298. log.Info("reconciled secret") // Log once if on success in any verbosity
  299. } else {
  300. log.V(1).Info("reconciled secret") // Log all reconciliation cycles if higher verbosity applied
  301. }
  302. return ctrl.Result{
  303. RequeueAfter: refreshInt,
  304. }, nil
  305. }
  306. func deleteOrphanedSecrets(ctx context.Context, cl client.Client, externalSecret *esv1beta1.ExternalSecret) error {
  307. secretList := v1.SecretList{}
  308. lblValue := utils.ObjectHash(fmt.Sprintf("%v/%v", externalSecret.Namespace, externalSecret.Name))
  309. ls := &metav1.LabelSelector{
  310. MatchLabels: map[string]string{
  311. esv1beta1.LabelOwner: lblValue,
  312. },
  313. }
  314. labelSelector, err := metav1.LabelSelectorAsSelector(ls)
  315. if err != nil {
  316. return err
  317. }
  318. err = cl.List(ctx, &secretList, &client.ListOptions{LabelSelector: labelSelector})
  319. if err != nil {
  320. return err
  321. }
  322. for key, secret := range secretList.Items {
  323. if externalSecret.Spec.Target.Name != "" && secret.Name != externalSecret.Spec.Target.Name {
  324. err = cl.Delete(ctx, &secretList.Items[key])
  325. if err != nil {
  326. return err
  327. }
  328. }
  329. }
  330. return nil
  331. }
  332. func createOrUpdate(ctx context.Context, c client.Client, obj client.Object, f func() error, fieldOwner string) (bool, error) {
  333. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  334. key := client.ObjectKeyFromObject(obj)
  335. if err := c.Get(ctx, key, obj); err != nil {
  336. if !apierrors.IsNotFound(err) {
  337. return false, err
  338. }
  339. if err := f(); err != nil {
  340. return false, err
  341. }
  342. // Setting Field Owner even for CreationPolicy==Create
  343. if err := c.Create(ctx, obj, client.FieldOwner(fqdn)); err != nil {
  344. return false, err
  345. }
  346. return true, nil
  347. }
  348. existing := obj.DeepCopyObject()
  349. if err := f(); err != nil {
  350. return false, err
  351. }
  352. if equality.Semantic.DeepEqual(existing, obj) {
  353. return false, nil
  354. }
  355. if err := c.Update(ctx, obj, client.FieldOwner(fqdn)); err != nil {
  356. return false, err
  357. }
  358. return false, nil
  359. }
  360. func patchSecret(ctx context.Context, c client.Client, scheme *runtime.Scheme, secret *v1.Secret, mutationFunc func() error, fieldOwner string) error {
  361. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  362. err := c.Get(ctx, client.ObjectKeyFromObject(secret), secret.DeepCopy())
  363. if apierrors.IsNotFound(err) {
  364. return fmt.Errorf(errPolicyMergeNotFound, secret.Name)
  365. }
  366. if err != nil {
  367. return fmt.Errorf(errPolicyMergeGetSecret, secret.Name, err)
  368. }
  369. existing := secret.DeepCopyObject()
  370. err = mutationFunc()
  371. if err != nil {
  372. return fmt.Errorf(errPolicyMergeMutate, secret.Name, err)
  373. }
  374. // GVK is missing in the Secret, see:
  375. // https://github.com/kubernetes-sigs/controller-runtime/issues/526
  376. // https://github.com/kubernetes-sigs/controller-runtime/issues/1517
  377. // https://github.com/kubernetes/kubernetes/issues/80609
  378. // we need to manually set it before doing a Patch() as it depends on the GVK
  379. gvks, unversioned, err := scheme.ObjectKinds(secret)
  380. if err != nil {
  381. return err
  382. }
  383. if !unversioned && len(gvks) == 1 {
  384. secret.SetGroupVersionKind(gvks[0])
  385. }
  386. if equality.Semantic.DeepEqual(existing, secret) {
  387. return nil
  388. }
  389. // Cleaning up Managed fields manually as to keep patch coherence
  390. secret.ObjectMeta.ManagedFields = nil
  391. // we're not able to resolve conflicts so we force ownership
  392. // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#using-server-side-apply-in-a-controller
  393. err = c.Patch(ctx, secret, client.Apply, client.FieldOwner(fqdn), client.ForceOwnership)
  394. if err != nil {
  395. return fmt.Errorf(errPolicyMergePatch, secret.Name, err)
  396. }
  397. return nil
  398. }
  399. func getManagedKeys(secret *v1.Secret, fieldOwner string) ([]string, error) {
  400. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  401. var keys []string
  402. for _, v := range secret.ObjectMeta.ManagedFields {
  403. if v.Manager != fqdn {
  404. continue
  405. }
  406. fields := make(map[string]interface{})
  407. err := json.Unmarshal(v.FieldsV1.Raw, &fields)
  408. if err != nil {
  409. return nil, fmt.Errorf("error unmarshaling managed fields: %w", err)
  410. }
  411. dataFields := fields["f:data"]
  412. if dataFields == nil {
  413. continue
  414. }
  415. df, ok := dataFields.(map[string]interface{})
  416. if !ok {
  417. continue
  418. }
  419. for k := range df {
  420. if k == "." {
  421. continue
  422. }
  423. keys = append(keys, strings.TrimPrefix(k, "f:"))
  424. }
  425. }
  426. return keys, nil
  427. }
  428. func getResourceVersion(es esv1beta1.ExternalSecret) string {
  429. return fmt.Sprintf("%d-%s", es.ObjectMeta.GetGeneration(), hashMeta(es.ObjectMeta))
  430. }
  431. func hashMeta(m metav1.ObjectMeta) string {
  432. type meta struct {
  433. annotations map[string]string
  434. labels map[string]string
  435. }
  436. return utils.ObjectHash(meta{
  437. annotations: m.Annotations,
  438. labels: m.Labels,
  439. })
  440. }
  441. func shouldSkipClusterSecretStore(r *Reconciler, es esv1beta1.ExternalSecret) bool {
  442. return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind
  443. }
  444. // shouldSkipUnmanagedStore iterates over all secretStore references in the externalSecret spec,
  445. // fetches the store and evaluates the controllerClass property.
  446. // Returns true if any storeRef points to store with a non-matching controllerClass.
  447. func shouldSkipUnmanagedStore(ctx context.Context, namespace string, r *Reconciler, es esv1beta1.ExternalSecret) (bool, error) {
  448. var storeList []esv1beta1.SecretStoreRef
  449. if es.Spec.SecretStoreRef.Name != "" {
  450. storeList = append(storeList, es.Spec.SecretStoreRef)
  451. }
  452. for _, ref := range es.Spec.Data {
  453. if ref.SourceRef != nil && ref.SourceRef.SecretStoreRef != nil {
  454. storeList = append(storeList, *ref.SourceRef.SecretStoreRef)
  455. }
  456. }
  457. for _, ref := range es.Spec.DataFrom {
  458. if ref.SourceRef != nil && ref.SourceRef.SecretStoreRef != nil {
  459. storeList = append(storeList, *ref.SourceRef.SecretStoreRef)
  460. }
  461. // verify that generator's controllerClass matches
  462. if ref.SourceRef != nil && ref.SourceRef.GeneratorRef != nil {
  463. genDef, err := r.getGeneratorDefinition(ctx, namespace, ref.SourceRef)
  464. if err != nil {
  465. return false, err
  466. }
  467. skipGenerator, err := shouldSkipGenerator(r, genDef)
  468. if err != nil {
  469. return false, err
  470. }
  471. if skipGenerator {
  472. return true, nil
  473. }
  474. }
  475. }
  476. for _, ref := range storeList {
  477. var store esv1beta1.GenericStore
  478. switch ref.Kind {
  479. case esv1beta1.SecretStoreKind, "":
  480. store = &esv1beta1.SecretStore{}
  481. case esv1beta1.ClusterSecretStoreKind:
  482. store = &esv1beta1.ClusterSecretStore{}
  483. namespace = ""
  484. }
  485. err := r.Client.Get(ctx, types.NamespacedName{
  486. Name: ref.Name,
  487. Namespace: namespace,
  488. }, store)
  489. if err != nil {
  490. return false, err
  491. }
  492. class := store.GetSpec().Controller
  493. if class != "" && class != r.ControllerClass {
  494. return true, nil
  495. }
  496. }
  497. return false, nil
  498. }
  499. func shouldRefresh(es esv1beta1.ExternalSecret) bool {
  500. // refresh if resource version changed
  501. if es.Status.SyncedResourceVersion != getResourceVersion(es) {
  502. return true
  503. }
  504. // skip refresh if refresh interval is 0
  505. if es.Spec.RefreshInterval.Duration == 0 && es.Status.SyncedResourceVersion != "" {
  506. return false
  507. }
  508. if es.Status.RefreshTime.IsZero() {
  509. return true
  510. }
  511. return es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).Before(time.Now())
  512. }
  513. func shouldReconcile(es esv1beta1.ExternalSecret) bool {
  514. if es.Spec.Target.Immutable && hasSyncedCondition(es) {
  515. return false
  516. }
  517. return true
  518. }
  519. func hasSyncedCondition(es esv1beta1.ExternalSecret) bool {
  520. for _, condition := range es.Status.Conditions {
  521. if condition.Reason == "SecretSynced" {
  522. return true
  523. }
  524. }
  525. return false
  526. }
  527. // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash.
  528. func isSecretValid(existingSecret v1.Secret) bool {
  529. // if target secret doesn't exist, or annotations as not set, we need to refresh
  530. if existingSecret.UID == "" || existingSecret.Annotations == nil {
  531. return false
  532. }
  533. // if the calculated hash is different from the calculation, then it's invalid
  534. if existingSecret.Annotations[esv1beta1.AnnotationDataHash] != utils.ObjectHash(existingSecret.Data) {
  535. return false
  536. }
  537. return true
  538. }
  539. // computeDataHashAnnotation generate a hash of the secret data combining the old key with the new keys to add or override.
  540. func (r *Reconciler) computeDataHashAnnotation(existing, secret *v1.Secret) string {
  541. data := make(map[string][]byte)
  542. for k, v := range existing.Data {
  543. data[k] = v
  544. }
  545. for k, v := range secret.Data {
  546. data[k] = v
  547. }
  548. return utils.ObjectHash(data)
  549. }
  550. // SetupWithManager returns a new controller builder that will be started by the provided Manager.
  551. func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error {
  552. r.recorder = mgr.GetEventRecorderFor("external-secrets")
  553. return ctrl.NewControllerManagedBy(mgr).
  554. WithOptions(opts).
  555. For(&esv1beta1.ExternalSecret{}).
  556. Owns(&v1.Secret{}, builder.OnlyMetadata).
  557. Complete(r)
  558. }