externalsecret_controller.go 22 KB

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