externalsecret_controller.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621
  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. "errors"
  17. "fmt"
  18. "strings"
  19. "time"
  20. "github.com/go-logr/logr"
  21. "github.com/prometheus/client_golang/prometheus"
  22. v1 "k8s.io/api/core/v1"
  23. "k8s.io/apimachinery/pkg/api/equality"
  24. apierrors "k8s.io/apimachinery/pkg/api/errors"
  25. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  26. "k8s.io/apimachinery/pkg/runtime"
  27. "k8s.io/apimachinery/pkg/types"
  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. "github.com/external-secrets/external-secrets/pkg/controllers/secretstore"
  36. // Loading registered providers.
  37. _ "github.com/external-secrets/external-secrets/pkg/provider/register"
  38. "github.com/external-secrets/external-secrets/pkg/utils"
  39. )
  40. const (
  41. requeueAfter = time.Second * 30
  42. fieldOwnerTemplate = "externalsecrets.external-secrets.io/%v"
  43. errGetES = "could not get ExternalSecret"
  44. errConvert = "could not apply conversion strategy to keys: %v"
  45. errDecode = "could not apply decoding strategy to %v[%d]: %v"
  46. errRewrite = "could not rewrite spec.dataFrom[%d]: %v"
  47. 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)"
  48. errUpdateSecret = "could not update Secret"
  49. errPatchStatus = "unable to patch status"
  50. errGetSecretStore = "could not get SecretStore %q, %w"
  51. errSecretStoreNotReady = "the desired SecretStore %s is not ready"
  52. errGetClusterSecretStore = "could not get ClusterSecretStore %q, %w"
  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. ControllerClass string
  79. RequeueInterval time.Duration
  80. ClusterSecretStoreEnabled bool
  81. EnableFloodGate bool
  82. recorder record.EventRecorder
  83. }
  84. // Reconcile implements the main reconciliation loop
  85. // for watched objects (ExternalSecret, ClusterSecretStore and SecretStore),
  86. // and updates/creates a Kubernetes secret based on them.
  87. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
  88. log := r.Log.WithValues("ExternalSecret", req.NamespacedName)
  89. syncCallsMetricLabels := prometheus.Labels{"name": req.Name, "namespace": req.Namespace}
  90. start := time.Now()
  91. defer externalSecretReconcileDuration.With(prometheus.Labels{
  92. "name": req.Name,
  93. "namespace": req.Namespace,
  94. }).Set(float64(time.Since(start)))
  95. var externalSecret esv1beta1.ExternalSecret
  96. err := r.Get(ctx, req.NamespacedName, &externalSecret)
  97. if apierrors.IsNotFound(err) {
  98. syncCallsTotal.With(syncCallsMetricLabels).Inc()
  99. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretDeleted, v1.ConditionFalse, esv1beta1.ConditionReasonSecretDeleted, "Secret was deleted")
  100. SetExternalSecretCondition(&esv1beta1.ExternalSecret{
  101. ObjectMeta: metav1.ObjectMeta{
  102. Name: req.Name,
  103. Namespace: req.Namespace,
  104. },
  105. }, *conditionSynced)
  106. return ctrl.Result{}, nil
  107. } else if err != nil {
  108. log.Error(err, errGetES)
  109. syncCallsError.With(syncCallsMetricLabels).Inc()
  110. return ctrl.Result{}, nil
  111. }
  112. if shouldSkipClusterSecretStore(r, externalSecret) {
  113. log.Info("skipping cluster secret store as it is disabled")
  114. return ctrl.Result{}, nil
  115. }
  116. // patch status when done processing
  117. p := client.MergeFrom(externalSecret.DeepCopy())
  118. defer func() {
  119. err = r.Status().Patch(ctx, &externalSecret, p)
  120. if err != nil {
  121. log.Error(err, errPatchStatus)
  122. }
  123. }()
  124. store, err := r.getStore(ctx, &externalSecret)
  125. if err != nil {
  126. log.Error(err, errStoreRef)
  127. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonInvalidStoreRef, err.Error())
  128. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errStoreRef)
  129. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  130. syncCallsError.With(syncCallsMetricLabels).Inc()
  131. return ctrl.Result{}, err
  132. }
  133. log = log.WithValues("SecretStore", store.GetNamespacedName())
  134. // check if store should be handled by this controller instance
  135. if !secretstore.ShouldProcessStore(store, r.ControllerClass) {
  136. log.Info("skipping unmanaged store")
  137. return ctrl.Result{}, nil
  138. }
  139. if r.EnableFloodGate {
  140. if err = assertStoreIsUsable(store); err != nil {
  141. log.Error(err, errStoreUsability)
  142. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUnavailableStore, err.Error())
  143. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errStoreUsability)
  144. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  145. syncCallsError.With(syncCallsMetricLabels).Inc()
  146. return ctrl.Result{}, err
  147. }
  148. }
  149. storeProvider, err := esv1beta1.GetProvider(store)
  150. if err != nil {
  151. log.Error(err, errStoreProvider)
  152. syncCallsError.With(syncCallsMetricLabels).Inc()
  153. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  154. }
  155. refreshInt := r.RequeueInterval
  156. if externalSecret.Spec.RefreshInterval != nil {
  157. refreshInt = externalSecret.Spec.RefreshInterval.Duration
  158. }
  159. // Target Secret Name should default to the ExternalSecret name if not explicitly specified
  160. secretName := externalSecret.Spec.Target.Name
  161. if secretName == "" {
  162. secretName = externalSecret.ObjectMeta.Name
  163. }
  164. // fetch external secret, we need to ensure that it exists, and it's hashmap corresponds
  165. var existingSecret v1.Secret
  166. err = r.Get(ctx, types.NamespacedName{
  167. Name: secretName,
  168. Namespace: externalSecret.Namespace,
  169. }, &existingSecret)
  170. if err != nil && !apierrors.IsNotFound(err) {
  171. log.Error(err, errGetExistingSecret)
  172. }
  173. // refresh should be skipped if
  174. // 1. resource generation hasn't changed
  175. // 2. refresh interval is 0
  176. // 3. if we're still within refresh-interval
  177. if !shouldRefresh(externalSecret) && isSecretValid(existingSecret) {
  178. log.V(1).Info("skipping refresh", "rv", getResourceVersion(externalSecret))
  179. return ctrl.Result{RequeueAfter: refreshInt}, nil
  180. }
  181. if !shouldReconcile(externalSecret) {
  182. log.V(1).Info("stopping reconciling", "rv", getResourceVersion(externalSecret))
  183. return ctrl.Result{
  184. RequeueAfter: 0,
  185. Requeue: false,
  186. }, nil
  187. }
  188. // secret client is created only if we are going to refresh
  189. // this skip an unnecessary check/request in the case we are not going to do anything
  190. secretClient, err := storeProvider.NewClient(ctx, store, r.Client, req.Namespace)
  191. if err != nil {
  192. log.Error(err, errStoreClient)
  193. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errStoreClient)
  194. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  195. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonProviderClientConfig, err.Error())
  196. syncCallsError.With(syncCallsMetricLabels).Inc()
  197. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  198. }
  199. defer func() {
  200. err = secretClient.Close(ctx)
  201. if err != nil {
  202. log.Error(err, errCloseStoreClient)
  203. }
  204. }()
  205. secret := &v1.Secret{
  206. ObjectMeta: metav1.ObjectMeta{
  207. Name: secretName,
  208. Namespace: externalSecret.Namespace,
  209. },
  210. Immutable: &externalSecret.Spec.Target.Immutable,
  211. Data: make(map[string][]byte),
  212. }
  213. dataMap, err := r.getProviderSecretData(ctx, secretClient, &externalSecret)
  214. if err != nil {
  215. log.Error(err, errGetSecretData)
  216. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  217. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errGetSecretData)
  218. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  219. syncCallsError.With(syncCallsMetricLabels).Inc()
  220. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  221. }
  222. // if no data was found we can delete the secret if needed.
  223. if len(dataMap) == 0 {
  224. switch externalSecret.Spec.Target.DeletionPolicy {
  225. // delete secret and return early.
  226. case esv1beta1.DeletionPolicyDelete:
  227. // safeguard that we only can delete secrets we own
  228. // this is also implemented in the es validation webhook
  229. if externalSecret.Spec.Target.CreationPolicy != esv1beta1.CreatePolicyOwner {
  230. err := fmt.Errorf(errInvalidCreatePolicy, externalSecret.Spec.Target.CreationPolicy)
  231. log.Error(err, errDeleteSecret)
  232. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  233. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  234. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  235. syncCallsError.With(syncCallsMetricLabels).Inc()
  236. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  237. }
  238. err = r.Delete(ctx, secret)
  239. if err != nil && !apierrors.IsNotFound(err) {
  240. log.Error(err, errDeleteSecret)
  241. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  242. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret)
  243. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  244. syncCallsError.With(syncCallsMetricLabels).Inc()
  245. }
  246. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretDeleted, "secret deleted due to DeletionPolicy")
  247. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  248. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  249. case esv1beta1.DeletionPolicyMerge:
  250. // noop, handled below
  251. // In case provider secrets don't exist the kubernetes secret will be kept as-is.
  252. case esv1beta1.DeletionPolicyRetain:
  253. return ctrl.Result{RequeueAfter: requeueAfter}, nil
  254. }
  255. }
  256. mutationFunc := func() error {
  257. if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner {
  258. err = controllerutil.SetControllerReference(&externalSecret, &secret.ObjectMeta, r.Scheme)
  259. if err != nil {
  260. return fmt.Errorf(errSetCtrlReference, err)
  261. }
  262. }
  263. if secret.Data == nil {
  264. secret.Data = make(map[string][]byte)
  265. }
  266. err = r.applyTemplate(ctx, &externalSecret, secret, dataMap)
  267. if err != nil {
  268. return fmt.Errorf(errApplyTemplate, err)
  269. }
  270. // diff existing keys
  271. if externalSecret.Spec.Target.DeletionPolicy == esv1beta1.DeletionPolicyMerge {
  272. keys, err := getManagedKeys(&existingSecret, externalSecret.Name)
  273. if err != nil {
  274. return err
  275. }
  276. for _, key := range keys {
  277. if dataMap[key] == nil {
  278. secret.Data[key] = nil
  279. }
  280. }
  281. }
  282. return nil
  283. }
  284. //nolint
  285. switch externalSecret.Spec.Target.CreationPolicy {
  286. case esv1beta1.CreatePolicyMerge:
  287. err = patchSecret(ctx, r.Client, r.Scheme, secret, mutationFunc, externalSecret.Name)
  288. case esv1beta1.CreatePolicyNone:
  289. log.V(1).Info("secret creation skipped due to creationPolicy=None")
  290. err = nil
  291. default:
  292. _, err = ctrl.CreateOrUpdate(ctx, r.Client, secret, mutationFunc)
  293. }
  294. if err != nil {
  295. log.Error(err, errUpdateSecret)
  296. r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error())
  297. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errUpdateSecret)
  298. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  299. syncCallsError.With(syncCallsMetricLabels).Inc()
  300. return ctrl.Result{}, err
  301. }
  302. r.recorder.Event(&externalSecret, v1.EventTypeNormal, esv1beta1.ReasonUpdated, "Updated Secret")
  303. conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretSynced, "Secret was synced")
  304. currCond := GetExternalSecretCondition(externalSecret.Status, esv1beta1.ExternalSecretReady)
  305. SetExternalSecretCondition(&externalSecret, *conditionSynced)
  306. externalSecret.Status.RefreshTime = metav1.NewTime(time.Now())
  307. externalSecret.Status.SyncedResourceVersion = getResourceVersion(externalSecret)
  308. syncCallsTotal.With(syncCallsMetricLabels).Inc()
  309. if currCond == nil || currCond.Status != conditionSynced.Status {
  310. log.Info("reconciled secret") // Log once if on success in any verbosity
  311. } else {
  312. log.V(1).Info("reconciled secret") // Log all reconciliation cycles if higher verbosity applied
  313. }
  314. return ctrl.Result{
  315. RequeueAfter: refreshInt,
  316. }, nil
  317. }
  318. func patchSecret(ctx context.Context, c client.Client, scheme *runtime.Scheme, secret *v1.Secret, mutationFunc func() error, fieldOwner string) error {
  319. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  320. err := c.Get(ctx, client.ObjectKeyFromObject(secret), secret.DeepCopy())
  321. if apierrors.IsNotFound(err) {
  322. return fmt.Errorf(errPolicyMergeNotFound, secret.Name)
  323. }
  324. if err != nil {
  325. return fmt.Errorf(errPolicyMergeGetSecret, secret.Name, err)
  326. }
  327. existing := secret.DeepCopyObject()
  328. err = mutationFunc()
  329. if err != nil {
  330. return fmt.Errorf(errPolicyMergeMutate, secret.Name, err)
  331. }
  332. // GVK is missing in the Secret, see:
  333. // https://github.com/kubernetes-sigs/controller-runtime/issues/526
  334. // https://github.com/kubernetes-sigs/controller-runtime/issues/1517
  335. // https://github.com/kubernetes/kubernetes/issues/80609
  336. // we need to manually set it before doing a Patch() as it depends on the GVK
  337. gvks, unversioned, err := scheme.ObjectKinds(secret)
  338. if err != nil {
  339. return err
  340. }
  341. if !unversioned && len(gvks) == 1 {
  342. secret.SetGroupVersionKind(gvks[0])
  343. }
  344. if equality.Semantic.DeepEqual(existing, secret) {
  345. return nil
  346. }
  347. // we're not able to resolve conflicts so we force ownership
  348. // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#using-server-side-apply-in-a-controller
  349. err = c.Patch(ctx, secret, client.Apply, client.FieldOwner(fqdn), client.ForceOwnership)
  350. if err != nil {
  351. return fmt.Errorf(errPolicyMergePatch, secret.Name, err)
  352. }
  353. return nil
  354. }
  355. func getManagedKeys(secret *v1.Secret, fieldOwner string) ([]string, error) {
  356. fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner)
  357. var keys []string
  358. for _, v := range secret.ObjectMeta.ManagedFields {
  359. if v.Manager != fqdn {
  360. continue
  361. }
  362. fields := make(map[string]interface{})
  363. err := json.Unmarshal(v.FieldsV1.Raw, &fields)
  364. if err != nil {
  365. return nil, fmt.Errorf("error unmarshaling managed fields: %w", err)
  366. }
  367. dataFields := fields["f:data"]
  368. if dataFields == nil {
  369. continue
  370. }
  371. df, ok := dataFields.(map[string]string)
  372. if !ok {
  373. continue
  374. }
  375. for k := range df {
  376. if k == "." {
  377. continue
  378. }
  379. keys = append(keys, strings.TrimPrefix(k, "f:"))
  380. }
  381. }
  382. return keys, nil
  383. }
  384. func getResourceVersion(es esv1beta1.ExternalSecret) string {
  385. return fmt.Sprintf("%d-%s", es.ObjectMeta.GetGeneration(), hashMeta(es.ObjectMeta))
  386. }
  387. func hashMeta(m metav1.ObjectMeta) string {
  388. type meta struct {
  389. annotations map[string]string
  390. labels map[string]string
  391. }
  392. return utils.ObjectHash(meta{
  393. annotations: m.Annotations,
  394. labels: m.Labels,
  395. })
  396. }
  397. func shouldSkipClusterSecretStore(r *Reconciler, es esv1beta1.ExternalSecret) bool {
  398. return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind
  399. }
  400. func shouldRefresh(es esv1beta1.ExternalSecret) bool {
  401. // refresh if resource version changed
  402. if es.Status.SyncedResourceVersion != getResourceVersion(es) {
  403. return true
  404. }
  405. // skip refresh if refresh interval is 0
  406. if es.Spec.RefreshInterval.Duration == 0 && es.Status.SyncedResourceVersion != "" {
  407. return false
  408. }
  409. if es.Status.RefreshTime.IsZero() {
  410. return true
  411. }
  412. return es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).Before(time.Now())
  413. }
  414. func shouldReconcile(es esv1beta1.ExternalSecret) bool {
  415. if es.Spec.Target.Immutable && hasSyncedCondition(es) {
  416. return false
  417. }
  418. return true
  419. }
  420. func hasSyncedCondition(es esv1beta1.ExternalSecret) bool {
  421. for _, condition := range es.Status.Conditions {
  422. if condition.Reason == "SecretSynced" {
  423. return true
  424. }
  425. }
  426. return false
  427. }
  428. // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash.
  429. func isSecretValid(existingSecret v1.Secret) bool {
  430. // if target secret doesn't exist, or annotations as not set, we need to refresh
  431. if existingSecret.UID == "" || existingSecret.Annotations == nil {
  432. return false
  433. }
  434. // if the calculated hash is different from the calculation, then it's invalid
  435. if existingSecret.Annotations[esv1beta1.AnnotationDataHash] != utils.ObjectHash(existingSecret.Data) {
  436. return false
  437. }
  438. return true
  439. }
  440. // assertStoreIsUsable assert that the store is ready to use.
  441. func assertStoreIsUsable(store esv1beta1.GenericStore) error {
  442. condition := secretstore.GetSecretStoreCondition(store.GetStatus(), esv1beta1.SecretStoreReady)
  443. if condition == nil || condition.Status != v1.ConditionTrue {
  444. return fmt.Errorf(errSecretStoreNotReady, store.GetName())
  445. }
  446. return nil
  447. }
  448. func (r *Reconciler) getStore(ctx context.Context, externalSecret *esv1beta1.ExternalSecret) (esv1beta1.GenericStore, error) {
  449. ref := types.NamespacedName{
  450. Name: externalSecret.Spec.SecretStoreRef.Name,
  451. }
  452. if externalSecret.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind {
  453. var store esv1beta1.ClusterSecretStore
  454. err := r.Get(ctx, ref, &store)
  455. if err != nil {
  456. return nil, fmt.Errorf(errGetClusterSecretStore, ref.Name, err)
  457. }
  458. return &store, nil
  459. }
  460. ref.Namespace = externalSecret.Namespace
  461. var store esv1beta1.SecretStore
  462. err := r.Get(ctx, ref, &store)
  463. if err != nil {
  464. return nil, fmt.Errorf(errGetSecretStore, ref.Name, err)
  465. }
  466. return &store, nil
  467. }
  468. // getProviderSecretData returns the provider's secret data with the provided ExternalSecret.
  469. func (r *Reconciler) getProviderSecretData(ctx context.Context, providerClient esv1beta1.SecretsClient, externalSecret *esv1beta1.ExternalSecret) (map[string][]byte, error) {
  470. providerData := make(map[string][]byte)
  471. for i, remoteRef := range externalSecret.Spec.DataFrom {
  472. var secretMap map[string][]byte
  473. var err error
  474. if remoteRef.Find != nil {
  475. secretMap, err = providerClient.GetAllSecrets(ctx, *remoteRef.Find)
  476. if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain {
  477. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonDeleted, fmt.Sprintf("secret does not exist at provider using .dataFrom[%d]", i))
  478. continue
  479. }
  480. if err != nil {
  481. return nil, err
  482. }
  483. secretMap, err = utils.RewriteMap(remoteRef.Rewrite, secretMap)
  484. if err != nil {
  485. return nil, fmt.Errorf(errRewrite, i, err)
  486. }
  487. if len(remoteRef.Rewrite) == 0 {
  488. // ConversionStrategy is deprecated. Use RewriteMap instead.
  489. r.recorder.Event(externalSecret, v1.EventTypeWarning, esv1beta1.ReasonDeprecated, fmt.Sprintf("dataFrom[%d].find.conversionStrategy=%v is deprecated and will be removed in further releases. Use dataFrom.rewrite instead", i, remoteRef.Find.ConversionStrategy))
  490. secretMap, err = utils.ConvertKeys(remoteRef.Find.ConversionStrategy, secretMap)
  491. if err != nil {
  492. return nil, fmt.Errorf(errConvert, err)
  493. }
  494. }
  495. if !utils.ValidateKeys(secretMap) {
  496. return nil, fmt.Errorf(errInvalidKeys, "find", i)
  497. }
  498. secretMap, err = utils.DecodeMap(remoteRef.Find.DecodingStrategy, secretMap)
  499. if err != nil {
  500. return nil, fmt.Errorf(errDecode, "spec.dataFrom", i, err)
  501. }
  502. } else if remoteRef.Extract != nil {
  503. secretMap, err = providerClient.GetSecretMap(ctx, *remoteRef.Extract)
  504. if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain {
  505. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonDeleted, fmt.Sprintf("secret does not exist at provider using .dataFrom[%d]", i))
  506. continue
  507. }
  508. if err != nil {
  509. return nil, err
  510. }
  511. secretMap, err = utils.RewriteMap(remoteRef.Rewrite, secretMap)
  512. if err != nil {
  513. return nil, fmt.Errorf(errRewrite, i, err)
  514. }
  515. if len(remoteRef.Rewrite) == 0 {
  516. secretMap, err = utils.ConvertKeys(remoteRef.Extract.ConversionStrategy, secretMap)
  517. if err != nil {
  518. return nil, fmt.Errorf(errConvert, err)
  519. }
  520. }
  521. if !utils.ValidateKeys(secretMap) {
  522. return nil, fmt.Errorf(errInvalidKeys, "extract", i)
  523. }
  524. secretMap, err = utils.DecodeMap(remoteRef.Extract.DecodingStrategy, secretMap)
  525. if err != nil {
  526. return nil, fmt.Errorf(errDecode, "spec.dataFrom", i, err)
  527. }
  528. }
  529. providerData = utils.MergeByteMap(providerData, secretMap)
  530. }
  531. for i, secretRef := range externalSecret.Spec.Data {
  532. secretData, err := providerClient.GetSecret(ctx, secretRef.RemoteRef)
  533. if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain {
  534. r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonDeleted, fmt.Sprintf("secret does not exist at provider using .data[%d] key=%s", i, secretRef.RemoteRef.Key))
  535. continue
  536. }
  537. if err != nil {
  538. return nil, err
  539. }
  540. secretData, err = utils.Decode(secretRef.RemoteRef.DecodingStrategy, secretData)
  541. if err != nil {
  542. return nil, fmt.Errorf(errDecode, "spec.data", i, err)
  543. }
  544. providerData[secretRef.SecretKey] = secretData
  545. }
  546. return providerData, nil
  547. }
  548. // SetupWithManager returns a new controller builder that will be started by the provided Manager.
  549. func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error {
  550. r.recorder = mgr.GetEventRecorderFor("external-secrets")
  551. return ctrl.NewControllerManagedBy(mgr).
  552. WithOptions(opts).
  553. For(&esv1beta1.ExternalSecret{}).
  554. Owns(&v1.Secret{}, builder.OnlyMetadata).
  555. Complete(r)
  556. }