externalsecret_controller.go 23 KB

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