pushsecret_controller.go 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317
  1. /*
  2. Copyright © The ESO Authors
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // Package pushsecret implements the controller for managing PushSecret resources.
  14. package pushsecret
  15. import (
  16. "bytes"
  17. "context"
  18. "errors"
  19. "fmt"
  20. "maps"
  21. "regexp"
  22. "slices"
  23. "strings"
  24. "text/template"
  25. "time"
  26. "github.com/go-logr/logr"
  27. v1 "k8s.io/api/core/v1"
  28. apierrors "k8s.io/apimachinery/pkg/api/errors"
  29. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  30. "k8s.io/apimachinery/pkg/labels"
  31. "k8s.io/apimachinery/pkg/runtime"
  32. "k8s.io/apimachinery/pkg/types"
  33. "k8s.io/client-go/rest"
  34. "k8s.io/client-go/tools/record"
  35. ctrl "sigs.k8s.io/controller-runtime"
  36. "sigs.k8s.io/controller-runtime/pkg/client"
  37. "sigs.k8s.io/controller-runtime/pkg/controller"
  38. "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
  39. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  40. esapi "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  41. genv1alpha1 "github.com/external-secrets/external-secrets/apis/generators/v1alpha1"
  42. ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
  43. "github.com/external-secrets/external-secrets/pkg/controllers/pushsecret/psmetrics"
  44. ctrlutil "github.com/external-secrets/external-secrets/pkg/controllers/util"
  45. "github.com/external-secrets/external-secrets/runtime/clientmanager"
  46. "github.com/external-secrets/external-secrets/runtime/esutils"
  47. "github.com/external-secrets/external-secrets/runtime/esutils/resolvers"
  48. "github.com/external-secrets/external-secrets/runtime/statemanager"
  49. estemplate "github.com/external-secrets/external-secrets/runtime/template/v2"
  50. "github.com/external-secrets/external-secrets/runtime/util/locks"
  51. // Load registered generators.
  52. _ "github.com/external-secrets/external-secrets/pkg/register"
  53. )
  54. const (
  55. errFailedGetSecret = "could not get source secret"
  56. errPatchStatus = "error merging"
  57. errGetSecretStore = "could not get SecretStore %q, %w"
  58. errGetClusterSecretStore = "could not get ClusterSecretStore %q, %w"
  59. errSetSecretFailed = "could not write remote ref %v to target secretstore %v: %v"
  60. errFailedSetSecret = "set secret failed: %v"
  61. errConvert = "could not apply conversion strategy to keys: %v"
  62. pushSecretFinalizer = "pushsecret.externalsecrets.io/finalizer"
  63. errCloudNotUpdateFinalizer = "could not update finalizers: %w"
  64. bundleSourceKey = "(bundle)"
  65. )
  66. // Reconciler is the controller for PushSecret resources.
  67. // It manages the lifecycle of PushSecrets, ensuring that secrets are pushed to
  68. // specified secret stores according to the defined policies and templates.
  69. type Reconciler struct {
  70. client.Client
  71. Log logr.Logger
  72. Scheme *runtime.Scheme
  73. recorder record.EventRecorder
  74. RestConfig *rest.Config
  75. RequeueInterval time.Duration
  76. ControllerClass string
  77. }
  78. // storeInfo holds the identifying attributes of a secret store for per-store processing.
  79. type storeInfo struct {
  80. Name string
  81. Kind string
  82. Labels map[string]string
  83. }
  84. // SetupWithManager sets up the controller with the Manager.
  85. // It configures the controller to watch PushSecret resources and
  86. // manages indexing for efficient lookups based on secret stores and deletion policies.
  87. func (r *Reconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager, opts controller.Options) error {
  88. r.recorder = mgr.GetEventRecorderFor("pushsecret")
  89. // Index PushSecrets by the stores they have pushed to (for finalizer management on store deletion)
  90. // Refer to common.go for more details on the index function
  91. if err := mgr.GetFieldIndexer().IndexField(ctx, &esapi.PushSecret{}, "status.syncedPushSecrets", func(obj client.Object) []string {
  92. ps := obj.(*esapi.PushSecret)
  93. // Only index PushSecrets with DeletionPolicy=Delete for efficiency
  94. if ps.Spec.DeletionPolicy != esapi.PushSecretDeletionPolicyDelete {
  95. return nil
  96. }
  97. // Format is typically "Kind/Name" (e.g., "SecretStore/store1", "ClusterSecretStore/clusterstore1")
  98. storeKeys := make([]string, 0, len(ps.Status.SyncedPushSecrets))
  99. for storeKey := range ps.Status.SyncedPushSecrets {
  100. storeKeys = append(storeKeys, storeKey)
  101. }
  102. return storeKeys
  103. }); err != nil {
  104. return err
  105. }
  106. // Index PushSecrets by deletionPolicy for quick filtering
  107. if err := mgr.GetFieldIndexer().IndexField(ctx, &esapi.PushSecret{}, "spec.deletionPolicy", func(obj client.Object) []string {
  108. ps := obj.(*esapi.PushSecret)
  109. return []string{string(ps.Spec.DeletionPolicy)}
  110. }); err != nil {
  111. return err
  112. }
  113. return ctrl.NewControllerManagedBy(mgr).
  114. WithOptions(opts).
  115. For(&esapi.PushSecret{}).
  116. Complete(r)
  117. }
  118. // Reconcile is part of the main kubernetes reconciliation loop which aims to
  119. // move the current state of the cluster closer to the desired state.
  120. // For more details, check Reconcile and its Result here:
  121. // - https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/reconcile
  122. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
  123. log := r.Log.WithValues("pushsecret", req.NamespacedName)
  124. resourceLabels := ctrlmetrics.RefineNonConditionMetricLabels(map[string]string{"name": req.Name, "namespace": req.Namespace})
  125. start := time.Now()
  126. pushSecretReconcileDuration := psmetrics.GetGaugeVec(psmetrics.PushSecretReconcileDurationKey)
  127. defer func() { pushSecretReconcileDuration.With(resourceLabels).Set(float64(time.Since(start))) }()
  128. var ps esapi.PushSecret
  129. mgr := clientmanager.NewManager(r.Client, r.ControllerClass, false)
  130. defer func() {
  131. _ = mgr.Close(ctx)
  132. }()
  133. if err := r.Get(ctx, req.NamespacedName, &ps); err != nil {
  134. if apierrors.IsNotFound(err) {
  135. return ctrl.Result{}, nil
  136. }
  137. msg := "unable to get PushSecret"
  138. r.recorder.Event(&ps, v1.EventTypeWarning, esapi.ReasonErrored, msg)
  139. log.Error(err, msg)
  140. return ctrl.Result{}, fmt.Errorf("get resource: %w", err)
  141. }
  142. refreshInt := r.RequeueInterval
  143. if ps.Spec.RefreshInterval != nil {
  144. refreshInt = ps.Spec.RefreshInterval.Duration
  145. }
  146. p := client.MergeFrom(ps.DeepCopy())
  147. defer func() {
  148. err := r.Client.Status().Patch(ctx, &ps, p)
  149. if err != nil && !apierrors.IsNotFound(err) {
  150. log.Error(err, errPatchStatus)
  151. }
  152. }()
  153. // Get secret stores early so they can be used for finalizer deletion
  154. secretStoresV2, err := r.GetSecretStoresV2(ctx, ps)
  155. if err != nil {
  156. r.markAsFailed(err.Error(), &ps, nil)
  157. return ctrl.Result{}, err
  158. }
  159. // Filter and prepare stores (this logic was moved from later)
  160. activeSecretStores := make(map[esapi.PushSecretStoreRef]any, len(secretStoresV2))
  161. for ref, store := range secretStoresV2 {
  162. if v1Store, ok := store.(esv1.GenericStore); ok {
  163. if !v1Store.GetDeletionTimestamp().IsZero() {
  164. log.Info("skipping SecretStore that is being deleted", "storeName", v1Store.GetName(), "storeKind", v1Store.GetKind())
  165. continue
  166. }
  167. }
  168. activeSecretStores[ref] = store
  169. }
  170. activeSecretStoresV1 := make(map[esapi.PushSecretStoreRef]esv1.GenericStore)
  171. for ref, store := range activeSecretStores {
  172. if v1Store, ok := store.(esv1.GenericStore); ok {
  173. activeSecretStoresV1[ref] = v1Store
  174. }
  175. }
  176. filteredV1Stores := removeUnmanagedStores(ctx, req.Namespace, r, activeSecretStoresV1)
  177. finalStores := make(map[esapi.PushSecretStoreRef]any)
  178. for ref, store := range filteredV1Stores {
  179. finalStores[ref] = store
  180. }
  181. for ref, store := range activeSecretStores {
  182. if _, ok := store.(esv1.GenericStore); !ok {
  183. finalStores[ref] = store
  184. }
  185. }
  186. switch ps.Spec.DeletionPolicy {
  187. case esapi.PushSecretDeletionPolicyDelete:
  188. // finalizer logic. Only added if we should delete the secrets
  189. if ps.ObjectMeta.DeletionTimestamp.IsZero() {
  190. if added := controllerutil.AddFinalizer(&ps, pushSecretFinalizer); added {
  191. if err := r.Client.Update(ctx, &ps, &client.UpdateOptions{}); err != nil {
  192. return ctrl.Result{}, fmt.Errorf(errCloudNotUpdateFinalizer, err)
  193. }
  194. return ctrl.Result{Requeue: true}, nil
  195. }
  196. } else if controllerutil.ContainsFinalizer(&ps, pushSecretFinalizer) {
  197. // trigger a cleanup with no Synced Map
  198. badState, err := r.DeleteSecretFromProvidersV2(ctx, &ps, esapi.SyncedPushSecretsMap{}, finalStores)
  199. if err != nil {
  200. msg := fmt.Sprintf("Failed to Delete Secrets from Provider: %v", err)
  201. r.markAsFailed(msg, &ps, badState)
  202. return ctrl.Result{}, err
  203. }
  204. controllerutil.RemoveFinalizer(&ps, pushSecretFinalizer)
  205. if err := r.Client.Update(ctx, &ps, &client.UpdateOptions{}); err != nil {
  206. return ctrl.Result{}, fmt.Errorf("could not update finalizers: %w", err)
  207. }
  208. return ctrl.Result{}, nil
  209. }
  210. case esapi.PushSecretDeletionPolicyNone:
  211. if controllerutil.ContainsFinalizer(&ps, pushSecretFinalizer) {
  212. controllerutil.RemoveFinalizer(&ps, pushSecretFinalizer)
  213. if err := r.Client.Update(ctx, &ps, &client.UpdateOptions{}); err != nil {
  214. return ctrl.Result{}, fmt.Errorf(errCloudNotUpdateFinalizer, err)
  215. }
  216. }
  217. default:
  218. }
  219. timeSinceLastRefresh := 0 * time.Second
  220. if !ps.Status.RefreshTime.IsZero() {
  221. timeSinceLastRefresh = time.Since(ps.Status.RefreshTime.Time)
  222. }
  223. if !shouldRefresh(ps) {
  224. refreshInt = (ps.Spec.RefreshInterval.Duration - timeSinceLastRefresh) + 5*time.Second
  225. log.V(1).Info("skipping refresh", "rv", ctrlutil.GetResourceVersion(ps.ObjectMeta), "nr", refreshInt.Seconds())
  226. return ctrl.Result{RequeueAfter: refreshInt}, nil
  227. }
  228. if err := validateDataToStoreRefs(ps.Spec.DataTo, ps.Spec.SecretStoreRefs); err != nil {
  229. r.markAsFailed(err.Error(), &ps, nil)
  230. return ctrl.Result{}, err
  231. }
  232. // if no stores are managed by this controller
  233. if len(finalStores) == 0 {
  234. return ctrl.Result{}, nil
  235. }
  236. secrets, err := r.resolveSecrets(ctx, &ps)
  237. if err != nil {
  238. isSecretSelector := ps.Spec.Selector.Secret != nil && ps.Spec.Selector.Secret.Name != ""
  239. if apierrors.IsNotFound(err) && isSecretSelector &&
  240. ps.Spec.DeletionPolicy == esapi.PushSecretDeletionPolicyDelete &&
  241. len(ps.Status.SyncedPushSecrets) > 0 {
  242. return ctrl.Result{}, r.handleSourceSecretDeleted(ctx, &ps, mgr)
  243. }
  244. r.markAsFailed(errFailedGetSecret, &ps, nil)
  245. return ctrl.Result{}, err
  246. }
  247. resolvedStores := make([]storeInfo, 0, len(finalStores))
  248. for ref, store := range finalStores {
  249. if si, ok := resolvedStoreInfo(ref, store); ok {
  250. resolvedStores = append(resolvedStores, si)
  251. }
  252. }
  253. if err := validateDataToMatchesResolvedStores(ps.Spec.DataTo, resolvedStores); err != nil {
  254. r.markAsFailed(err.Error(), &ps, nil)
  255. return ctrl.Result{}, err
  256. }
  257. allSyncedSecrets := make(esapi.SyncedPushSecretsMap)
  258. for _, secret := range secrets {
  259. if err := r.applyTemplate(ctx, &ps, &secret); err != nil {
  260. return ctrl.Result{}, err
  261. }
  262. syncedSecrets, err := r.PushSecretToProvidersV2(ctx, finalStores, ps, &secret, mgr)
  263. if err != nil {
  264. if errors.Is(err, locks.ErrConflict) {
  265. log.Info("retry to acquire lock to update the secret later", "error", err)
  266. return ctrl.Result{Requeue: true}, nil
  267. }
  268. totalSecrets := mergeSecretState(syncedSecrets, ps.Status.SyncedPushSecrets)
  269. msg := fmt.Sprintf(errFailedSetSecret, err)
  270. r.markAsFailed(msg, &ps, totalSecrets)
  271. return ctrl.Result{}, err
  272. }
  273. switch ps.Spec.DeletionPolicy {
  274. case esapi.PushSecretDeletionPolicyDelete:
  275. badSyncState, err := r.DeleteSecretFromProvidersV2(ctx, &ps, syncedSecrets, finalStores)
  276. if err != nil {
  277. msg := fmt.Sprintf("Failed to Delete Secrets from Provider: %v", err)
  278. r.markAsFailed(msg, &ps, badSyncState)
  279. return ctrl.Result{}, err
  280. }
  281. case esapi.PushSecretDeletionPolicyNone:
  282. default:
  283. }
  284. allSyncedSecrets = mergeSecretState(allSyncedSecrets, syncedSecrets)
  285. }
  286. r.markAsDone(&ps, allSyncedSecrets, start)
  287. return ctrl.Result{RequeueAfter: refreshInt}, nil
  288. }
  289. // handleSourceSecretDeleted cleans up provider secrets when source Secret is unavailable.
  290. func (r *Reconciler) handleSourceSecretDeleted(ctx context.Context, ps *esapi.PushSecret, mgr *clientmanager.Manager) error {
  291. log := r.Log.WithValues("pushsecret", client.ObjectKeyFromObject(ps))
  292. log.Info("source secret unavailable, cleaning up provider secrets", "syncedSecrets", len(ps.Status.SyncedPushSecrets))
  293. badState, err := r.DeleteSecretFromProviders(ctx, ps, esapi.SyncedPushSecretsMap{}, mgr)
  294. if err != nil {
  295. msg := fmt.Sprintf("failed to cleanup provider secrets: %v", err)
  296. r.markAsFailed(msg, ps, badState)
  297. return err
  298. }
  299. r.setSecrets(ps, esapi.SyncedPushSecretsMap{})
  300. r.markAsSourceDeleted(ps)
  301. return nil
  302. }
  303. func shouldRefresh(ps esapi.PushSecret) bool {
  304. if ps.Status.SyncedResourceVersion != ctrlutil.GetResourceVersion(ps.ObjectMeta) {
  305. return true
  306. }
  307. if ps.Spec.RefreshInterval.Duration == 0 && ps.Status.SyncedResourceVersion != "" {
  308. return false
  309. }
  310. if ps.Status.RefreshTime.IsZero() {
  311. return true
  312. }
  313. return ps.Status.RefreshTime.Add(ps.Spec.RefreshInterval.Duration).Before(time.Now())
  314. }
  315. func (r *Reconciler) markAsFailed(msg string, ps *esapi.PushSecret, syncState esapi.SyncedPushSecretsMap) {
  316. cond := NewPushSecretCondition(esapi.PushSecretReady, v1.ConditionFalse, esapi.ReasonErrored, msg)
  317. SetPushSecretCondition(ps, *cond)
  318. if syncState != nil {
  319. r.setSecrets(ps, syncState)
  320. }
  321. r.recorder.Event(ps, v1.EventTypeWarning, esapi.ReasonErrored, msg)
  322. }
  323. func (r *Reconciler) markAsSourceDeleted(ps *esapi.PushSecret) {
  324. msg := "source secret deleted; provider secrets cleaned up"
  325. cond := NewPushSecretCondition(esapi.PushSecretReady, v1.ConditionFalse, esapi.ReasonSourceDeleted, msg)
  326. SetPushSecretCondition(ps, *cond)
  327. r.recorder.Event(ps, v1.EventTypeNormal, esapi.ReasonSourceDeleted, msg)
  328. }
  329. func (r *Reconciler) markAsDone(ps *esapi.PushSecret, secrets esapi.SyncedPushSecretsMap, start time.Time) {
  330. msg := "PushSecret synced successfully"
  331. if ps.Spec.UpdatePolicy == esapi.PushSecretUpdatePolicyIfNotExists {
  332. msg += ". Existing secrets in providers unchanged."
  333. }
  334. cond := NewPushSecretCondition(esapi.PushSecretReady, v1.ConditionTrue, esapi.ReasonSynced, msg)
  335. SetPushSecretCondition(ps, *cond)
  336. r.setSecrets(ps, secrets)
  337. ps.Status.RefreshTime = metav1.NewTime(start)
  338. ps.Status.SyncedResourceVersion = ctrlutil.GetResourceVersion(ps.ObjectMeta)
  339. r.recorder.Event(ps, v1.EventTypeNormal, esapi.ReasonSynced, msg)
  340. }
  341. func (r *Reconciler) setSecrets(ps *esapi.PushSecret, status esapi.SyncedPushSecretsMap) {
  342. ps.Status.SyncedPushSecrets = status
  343. }
  344. func mergeSecretState(newMap, old esapi.SyncedPushSecretsMap) esapi.SyncedPushSecretsMap {
  345. if newMap == nil {
  346. return old
  347. }
  348. out := newMap.DeepCopy()
  349. for k, v := range old {
  350. _, ok := out[k]
  351. if !ok {
  352. out[k] = make(map[string]esapi.PushSecretData)
  353. }
  354. maps.Insert(out[k], maps.All(v))
  355. }
  356. return out
  357. }
  358. // DeleteSecretFromProviders removes secrets from providers that are no longer needed.
  359. // It compares the existing synced secrets in the PushSecret status with the new desired state,
  360. // and deletes any secrets that are no longer present in the new state.
  361. func (r *Reconciler) DeleteSecretFromProviders(ctx context.Context, ps *esapi.PushSecret, newMap esapi.SyncedPushSecretsMap, mgr *clientmanager.Manager) (esapi.SyncedPushSecretsMap, error) {
  362. out := mergeSecretState(newMap, ps.Status.SyncedPushSecrets)
  363. for storeName, oldData := range ps.Status.SyncedPushSecrets {
  364. storeRef := esv1.SecretStoreRef{
  365. Name: strings.Split(storeName, "/")[1],
  366. Kind: strings.Split(storeName, "/")[0],
  367. }
  368. client, err := mgr.Get(ctx, storeRef, ps.Namespace, nil)
  369. if err != nil {
  370. return out, fmt.Errorf("could not get secrets client for store %v: %w", storeName, err)
  371. }
  372. newData, ok := newMap[storeName]
  373. if !ok {
  374. err = r.DeleteAllSecretsFromStore(ctx, client, oldData)
  375. if err != nil {
  376. return out, err
  377. }
  378. delete(out, storeName)
  379. continue
  380. }
  381. for oldEntry, oldRef := range oldData {
  382. _, ok := newData[oldEntry]
  383. if !ok {
  384. err = r.DeleteSecretFromStore(ctx, client, oldRef)
  385. if err != nil {
  386. return out, err
  387. }
  388. delete(out[storeName], oldEntry)
  389. }
  390. }
  391. }
  392. return out, nil
  393. }
  394. // DeleteAllSecretsFromStore removes all secrets from a given secret store.
  395. func (r *Reconciler) DeleteAllSecretsFromStore(ctx context.Context, client esv1.SecretsClient, data map[string]esapi.PushSecretData) error {
  396. for _, v := range data {
  397. err := r.DeleteSecretFromStore(ctx, client, v)
  398. if err != nil {
  399. return err
  400. }
  401. }
  402. return nil
  403. }
  404. // DeleteSecretFromStore removes a specific secret from a given secret store.
  405. func (r *Reconciler) DeleteSecretFromStore(ctx context.Context, client esv1.SecretsClient, data esapi.PushSecretData) error {
  406. return client.DeleteSecret(ctx, data.Match.RemoteRef)
  407. }
  408. // PushSecretToProviders pushes the secret data to the specified secret stores.
  409. // It iterates over each store and handles the push operation according to the
  410. // defined update policies and conversion strategies.
  411. func (r *Reconciler) PushSecretToProviders(
  412. ctx context.Context,
  413. stores map[esapi.PushSecretStoreRef]esv1.GenericStore,
  414. ps esapi.PushSecret,
  415. secret *v1.Secret,
  416. mgr *clientmanager.Manager,
  417. ) (esapi.SyncedPushSecretsMap, error) {
  418. out := make(esapi.SyncedPushSecretsMap)
  419. var err error
  420. for ref, store := range stores {
  421. si := storeInfo{Name: store.GetName(), Kind: ref.Kind, Labels: store.GetLabels()}
  422. out, err = r.handlePushSecretDataForStore(ctx, ps, secret, out, mgr, si)
  423. if err != nil {
  424. return out, err
  425. }
  426. }
  427. return out, nil
  428. }
  429. func (r *Reconciler) handlePushSecretDataForStore(
  430. ctx context.Context,
  431. ps esapi.PushSecret,
  432. secret *v1.Secret,
  433. out esapi.SyncedPushSecretsMap,
  434. mgr *clientmanager.Manager,
  435. si storeInfo,
  436. ) (esapi.SyncedPushSecretsMap, error) {
  437. storeKey := fmt.Sprintf("%v/%v", si.Kind, si.Name)
  438. out[storeKey] = make(map[string]esapi.PushSecretData)
  439. storeRef := esv1.SecretStoreRef{
  440. Name: si.Name,
  441. Kind: si.Kind,
  442. }
  443. secretClient, err := mgr.Get(ctx, storeRef, ps.GetNamespace(), nil)
  444. if err != nil {
  445. return out, fmt.Errorf("could not get secrets client for store %v: %w", si.Name, err)
  446. }
  447. storeSecret := secret.DeepCopy()
  448. filteredDataTo, err := filterDataToForStore(ps.Spec.DataTo, si.Name, si.Kind, si.Labels)
  449. if err != nil {
  450. return out, fmt.Errorf("failed to filter dataTo: %w", err)
  451. }
  452. dataToEntries, bundleOverrides, err := r.expandDataTo(storeSecret, filteredDataTo)
  453. if err != nil {
  454. return out, fmt.Errorf("failed to expand dataTo: %w", err)
  455. }
  456. allData, err := mergeDataEntries(dataToEntries, ps.Spec.Data, storeSecret)
  457. if err != nil {
  458. return out, fmt.Errorf("failed to merge data entries: %w", err)
  459. }
  460. originalStoreSecretData := storeSecret.Data
  461. for _, data := range allData {
  462. params := pushEntryParams{
  463. data: data,
  464. updatePolicy: ps.Spec.UpdatePolicy,
  465. originalData: originalStoreSecretData,
  466. dataOverride: bundleOverrides[statusRef(data)],
  467. storeName: si.Name,
  468. }
  469. if err := r.pushSecretEntry(ctx, secretClient, storeSecret, params); err != nil {
  470. return out, err
  471. }
  472. out[storeKey][statusRef(data)] = data
  473. }
  474. return out, nil
  475. }
  476. // pushEntryParams groups the parameters for pushSecretEntry to keep the
  477. // function signature within the recommended parameter count.
  478. type pushEntryParams struct {
  479. data esapi.PushSecretData
  480. updatePolicy esapi.PushSecretUpdatePolicy
  481. originalData map[string][]byte
  482. dataOverride map[string][]byte
  483. storeName string
  484. }
  485. // pushSecretEntry converts, validates, and pushes a single data entry to the provider.
  486. // If the update policy is IfNotExists and the secret already exists, the push is skipped.
  487. // params.dataOverride, when non-nil, replaces params.originalData for the conversion step —
  488. // used by bundle entries (dataTo with remoteKey) to restrict the pushed payload to matched keys only.
  489. func (r *Reconciler) pushSecretEntry(
  490. ctx context.Context,
  491. secretClient esv1.SecretsClient,
  492. storeSecret *v1.Secret,
  493. params pushEntryParams,
  494. ) error {
  495. sourceData := params.originalData
  496. if params.dataOverride != nil {
  497. sourceData = params.dataOverride
  498. }
  499. secretData, err := esutils.ReverseKeys(params.data.ConversionStrategy, sourceData)
  500. if err != nil {
  501. return fmt.Errorf(errConvert, err)
  502. }
  503. key := params.data.GetSecretKey()
  504. if !secretKeyExists(key, secretData) {
  505. return fmt.Errorf("secret key %v does not exist", key)
  506. }
  507. if params.updatePolicy == esapi.PushSecretUpdatePolicyIfNotExists {
  508. exists, err := secretClient.SecretExists(ctx, params.data.Match.RemoteRef)
  509. if err != nil {
  510. return fmt.Errorf("could not verify if secret exists in store: %w", err)
  511. }
  512. if exists {
  513. return nil
  514. }
  515. }
  516. localSecret := storeSecret.DeepCopy()
  517. localSecret.Data = secretData
  518. if err := secretClient.PushSecret(ctx, localSecret, params.data); err != nil {
  519. return fmt.Errorf(errSetSecretFailed, key, params.storeName, err)
  520. }
  521. return nil
  522. }
  523. func secretKeyExists(key string, data map[string][]byte) bool {
  524. _, ok := data[key]
  525. return key == "" || ok
  526. }
  527. const defaultGeneratorStateKey = "__pushsecret"
  528. func (r *Reconciler) resolveSecrets(ctx context.Context, ps *esapi.PushSecret) ([]v1.Secret, error) {
  529. var err error
  530. generatorState := statemanager.New(ctx, r.Client, r.Scheme, ps.Namespace, ps)
  531. defer func() {
  532. if err != nil {
  533. if err := generatorState.Rollback(); err != nil {
  534. r.Log.Error(err, "error rolling back generator state")
  535. }
  536. return
  537. }
  538. if err := generatorState.Commit(); err != nil {
  539. r.Log.Error(err, "error committing generator state")
  540. }
  541. }()
  542. switch {
  543. case ps.Spec.Selector.Secret != nil && ps.Spec.Selector.Secret.Name != "":
  544. secretName := types.NamespacedName{Name: ps.Spec.Selector.Secret.Name, Namespace: ps.Namespace}
  545. secret := &v1.Secret{}
  546. if err := r.Client.Get(ctx, secretName, secret); err != nil {
  547. return nil, err
  548. }
  549. generatorState.EnqueueFlagLatestStateForGC(defaultGeneratorStateKey)
  550. return []v1.Secret{*secret}, nil
  551. case ps.Spec.Selector.GeneratorRef != nil:
  552. secret, err := r.resolveSecretFromGenerator(ctx, ps.Namespace, ps.Spec.Selector.GeneratorRef, generatorState)
  553. if err != nil {
  554. return nil, fmt.Errorf("could not resolve secret from generator ref %v: %w", ps.Spec.Selector.GeneratorRef, err)
  555. }
  556. return []v1.Secret{*secret}, nil
  557. case ps.Spec.Selector.Secret != nil && ps.Spec.Selector.Secret.Selector != nil:
  558. labelSelector, err := metav1.LabelSelectorAsSelector(ps.Spec.Selector.Secret.Selector)
  559. if err != nil {
  560. return nil, err
  561. }
  562. var secretList v1.SecretList
  563. err = r.List(ctx, &secretList, &client.ListOptions{LabelSelector: labelSelector, Namespace: ps.Namespace})
  564. if err != nil {
  565. return nil, err
  566. }
  567. return secretList.Items, err
  568. }
  569. return nil, errors.New("no secret selector provided")
  570. }
  571. func (r *Reconciler) resolveSecretFromGenerator(ctx context.Context, namespace string, generatorRef *esv1.GeneratorRef, generatorState *statemanager.Manager) (*v1.Secret, error) {
  572. gen, genResource, err := resolvers.GeneratorRef(ctx, r.Client, r.Scheme, namespace, generatorRef)
  573. if err != nil {
  574. return nil, fmt.Errorf("unable to resolve generator: %w", err)
  575. }
  576. var prevState *genv1alpha1.GeneratorState
  577. if generatorState != nil {
  578. prevState, err = generatorState.GetLatestState(defaultGeneratorStateKey)
  579. if err != nil {
  580. return nil, fmt.Errorf("unable to get latest state: %w", err)
  581. }
  582. }
  583. secretMap, newState, err := gen.Generate(ctx, genResource, r.Client, namespace)
  584. if err != nil {
  585. return nil, fmt.Errorf("unable to generate: %w", err)
  586. }
  587. if prevState != nil && generatorState != nil {
  588. generatorState.EnqueueMoveStateToGC(defaultGeneratorStateKey)
  589. }
  590. if generatorState != nil {
  591. generatorState.EnqueueSetLatest(ctx, defaultGeneratorStateKey, namespace, genResource, gen, newState)
  592. }
  593. return &v1.Secret{
  594. ObjectMeta: metav1.ObjectMeta{
  595. Name: "___generated-secret",
  596. Namespace: namespace,
  597. },
  598. Data: secretMap,
  599. }, err
  600. }
  601. // GetSecretStores retrieves the SecretStore and ClusterSecretStore resources
  602. // referenced in the PushSecret. It supports both direct references by name
  603. // and label selectors to find multiple stores.
  604. func (r *Reconciler) GetSecretStores(ctx context.Context, ps esapi.PushSecret) (map[esapi.PushSecretStoreRef]esv1.GenericStore, error) {
  605. stores := make(map[esapi.PushSecretStoreRef]esv1.GenericStore)
  606. for _, refStore := range ps.Spec.SecretStoreRefs {
  607. if refStore.LabelSelector != nil {
  608. labelSelector, err := metav1.LabelSelectorAsSelector(refStore.LabelSelector)
  609. if err != nil {
  610. return nil, fmt.Errorf("could not convert labels: %w", err)
  611. }
  612. if refStore.Kind == esv1.ClusterSecretStoreKind {
  613. clusterSecretStoreList := esv1.ClusterSecretStoreList{}
  614. err = r.List(ctx, &clusterSecretStoreList, &client.ListOptions{LabelSelector: labelSelector})
  615. if err != nil {
  616. return nil, fmt.Errorf("could not list cluster Secret Stores: %w", err)
  617. }
  618. for k, v := range clusterSecretStoreList.Items {
  619. key := esapi.PushSecretStoreRef{
  620. Name: v.Name,
  621. Kind: esv1.ClusterSecretStoreKind,
  622. }
  623. stores[key] = &clusterSecretStoreList.Items[k]
  624. }
  625. } else {
  626. secretStoreList := esv1.SecretStoreList{}
  627. err = r.List(ctx, &secretStoreList, &client.ListOptions{LabelSelector: labelSelector, Namespace: ps.Namespace})
  628. if err != nil {
  629. return nil, fmt.Errorf("could not list Secret Stores: %w", err)
  630. }
  631. for k, v := range secretStoreList.Items {
  632. key := esapi.PushSecretStoreRef{
  633. Name: v.Name,
  634. Kind: esv1.SecretStoreKind,
  635. }
  636. stores[key] = &secretStoreList.Items[k]
  637. }
  638. }
  639. } else {
  640. store, err := r.getSecretStoreFromName(ctx, refStore, ps.Namespace)
  641. if err != nil {
  642. return nil, err
  643. }
  644. stores[refStore] = store
  645. }
  646. }
  647. return stores, nil
  648. }
  649. func (r *Reconciler) getSecretStoreFromName(ctx context.Context, refStore esapi.PushSecretStoreRef, ns string) (esv1.GenericStore, error) {
  650. if refStore.Name == "" {
  651. return nil, errors.New("refStore Name must be provided")
  652. }
  653. ref := types.NamespacedName{
  654. Name: refStore.Name,
  655. }
  656. if refStore.Kind == esv1.ClusterSecretStoreKind {
  657. var store esv1.ClusterSecretStore
  658. err := r.Get(ctx, ref, &store)
  659. if err != nil {
  660. return nil, fmt.Errorf(errGetClusterSecretStore, ref.Name, err)
  661. }
  662. return &store, nil
  663. }
  664. ref.Namespace = ns
  665. var store esv1.SecretStore
  666. err := r.Get(ctx, ref, &store)
  667. if err != nil {
  668. return nil, fmt.Errorf(errGetSecretStore, ref.Name, err)
  669. }
  670. return &store, nil
  671. }
  672. // NewPushSecretCondition creates a new PushSecret condition.
  673. func NewPushSecretCondition(condType esapi.PushSecretConditionType, status v1.ConditionStatus, reason, message string) *esapi.PushSecretStatusCondition {
  674. return &esapi.PushSecretStatusCondition{
  675. Type: condType,
  676. Status: status,
  677. LastTransitionTime: metav1.Now(),
  678. Reason: reason,
  679. Message: message,
  680. }
  681. }
  682. // SetPushSecretCondition updates the PushSecret to include the provided condition.
  683. func SetPushSecretCondition(ps *esapi.PushSecret, condition esapi.PushSecretStatusCondition) {
  684. currentCond := GetPushSecretCondition(ps.Status.Conditions, condition.Type)
  685. if currentCond != nil && currentCond.Status == condition.Status &&
  686. currentCond.Reason == condition.Reason && currentCond.Message == condition.Message {
  687. psmetrics.UpdatePushSecretCondition(ps, &condition, 1.0)
  688. return
  689. }
  690. // Do not update lastTransitionTime if the status of the condition doesn't change.
  691. if currentCond != nil && currentCond.Status == condition.Status {
  692. condition.LastTransitionTime = currentCond.LastTransitionTime
  693. }
  694. ps.Status.Conditions = append(FilterOutCondition(ps.Status.Conditions, condition.Type), condition)
  695. if currentCond != nil {
  696. psmetrics.UpdatePushSecretCondition(ps, currentCond, 0.0)
  697. }
  698. psmetrics.UpdatePushSecretCondition(ps, &condition, 1.0)
  699. }
  700. // FilterOutCondition returns an empty set of conditions with the provided type.
  701. func FilterOutCondition(conditions []esapi.PushSecretStatusCondition, condType esapi.PushSecretConditionType) []esapi.PushSecretStatusCondition {
  702. newConditions := make([]esapi.PushSecretStatusCondition, 0, len(conditions))
  703. for _, c := range conditions {
  704. if c.Type == condType {
  705. continue
  706. }
  707. newConditions = append(newConditions, c)
  708. }
  709. return newConditions
  710. }
  711. // GetPushSecretCondition returns the condition with the provided type.
  712. func GetPushSecretCondition(conditions []esapi.PushSecretStatusCondition, condType esapi.PushSecretConditionType) *esapi.PushSecretStatusCondition {
  713. for i := range conditions {
  714. c := conditions[i]
  715. if c.Type == condType {
  716. return &c
  717. }
  718. }
  719. return nil
  720. }
  721. func statusRef(ref esv1.PushSecretData) string {
  722. if ref.GetProperty() != "" {
  723. return ref.GetRemoteKey() + "/" + ref.GetProperty()
  724. }
  725. return ref.GetRemoteKey()
  726. }
  727. // removeUnmanagedStores iterates over all SecretStore references and evaluates the controllerClass property.
  728. // Returns a map containing only managed stores.
  729. func removeUnmanagedStores(_ context.Context, _ string, r *Reconciler, ss map[esapi.PushSecretStoreRef]esv1.GenericStore) map[esapi.PushSecretStoreRef]esv1.GenericStore {
  730. for ref, store := range ss {
  731. class := store.GetSpec().Controller
  732. if class != "" && class != r.ControllerClass {
  733. delete(ss, ref)
  734. }
  735. }
  736. return ss
  737. }
  738. // matchKeys filters secret keys based on the provided match pattern.
  739. // If pattern is nil or empty, all keys are matched.
  740. func matchKeys(allKeys []string, match *esapi.PushSecretDataToMatch) ([]string, error) {
  741. if match == nil || match.RegExp == "" {
  742. return allKeys, nil
  743. }
  744. re, err := regexp.Compile(match.RegExp)
  745. if err != nil {
  746. return nil, fmt.Errorf("failed to compile regexp pattern %q: %w", match.RegExp, err)
  747. }
  748. matched := make([]string, 0)
  749. for _, key := range allKeys {
  750. if re.MatchString(key) {
  751. matched = append(matched, key)
  752. }
  753. }
  754. return matched, nil
  755. }
  756. // filterDataToForStore returns dataTo entries that target the given store.
  757. func filterDataToForStore(dataToList []esapi.PushSecretDataTo, storeName, storeKind string, storeLabels map[string]string) ([]esapi.PushSecretDataTo, error) {
  758. filtered := make([]esapi.PushSecretDataTo, 0, len(dataToList))
  759. for i, dataTo := range dataToList {
  760. matches, err := dataToMatchesStore(dataTo, storeName, storeKind, storeLabels)
  761. if err != nil {
  762. return nil, fmt.Errorf("dataTo[%d]: %w", i, err)
  763. }
  764. if matches {
  765. filtered = append(filtered, dataTo)
  766. }
  767. }
  768. return filtered, nil
  769. }
  770. // dataToMatchesStore reports whether a single dataTo entry targets the given store.
  771. func dataToMatchesStore(dataTo esapi.PushSecretDataTo, storeName, storeKind string, storeLabels map[string]string) (bool, error) {
  772. if dataTo.StoreRef == nil {
  773. return false, fmt.Errorf("storeRef is required")
  774. }
  775. refKind := dataTo.StoreRef.Kind
  776. if refKind == "" {
  777. refKind = esv1.SecretStoreKind
  778. }
  779. if dataTo.StoreRef.Name != "" {
  780. return dataTo.StoreRef.Name == storeName && refKind == storeKind, nil
  781. }
  782. if dataTo.StoreRef.LabelSelector == nil {
  783. return false, nil
  784. }
  785. selector, err := metav1.LabelSelectorAsSelector(dataTo.StoreRef.LabelSelector)
  786. if err != nil {
  787. return false, fmt.Errorf("invalid labelSelector: %w", err)
  788. }
  789. return refKind == storeKind && selector.Matches(labels.Set(storeLabels)), nil
  790. }
  791. // expandDataTo expands dataTo entries into individual PushSecretData entries.
  792. //
  793. // Two modes are supported per dataTo entry:
  794. //
  795. // Per-key mode (default, no remoteKey set): each matched key becomes a separate entry
  796. // pushed independently. This enables individual key transformation, per-key status
  797. // tracking, granular deletion, and compatibility with all providers.
  798. //
  799. // Bundle mode (remoteKey set): all matched keys are bundled into a single provider
  800. // secret at the given remoteKey path as a JSON object. A single PushSecretData entry
  801. // with SecretKey="" is produced, and the bundleOverrides map carries the filtered
  802. // key set so only matched keys appear in the pushed JSON blob.
  803. //
  804. // Returns the expanded entries, a bundleOverrides map (remoteKey -> filtered data),
  805. // and any error.
  806. func (r *Reconciler) expandDataTo(secret *v1.Secret, dataToList []esapi.PushSecretDataTo) ([]esapi.PushSecretData, map[string]map[string][]byte, error) {
  807. if len(dataToList) == 0 {
  808. return nil, nil, nil
  809. }
  810. allData := make([]esapi.PushSecretData, 0)
  811. bundleOverrides := make(map[string]map[string][]byte)
  812. overallRemoteKeys := make(map[string]string)
  813. for i, dataTo := range dataToList {
  814. entries, keyMap, filteredData, err := r.expandSingleDataTo(secret, dataTo)
  815. if err != nil {
  816. return nil, nil, fmt.Errorf("dataTo[%d]: %w", i, err)
  817. }
  818. if len(entries) == 0 {
  819. r.Log.Info("dataTo entry matched no keys", "index", i)
  820. continue
  821. }
  822. if err := registerRemoteKeys(overallRemoteKeys, keyMap, i); err != nil {
  823. return nil, nil, err
  824. }
  825. recordBundleOverrides(bundleOverrides, entries, filteredData)
  826. allData = append(allData, entries...)
  827. r.Log.Info("expanded dataTo entry", "index", i, "matchedKeys", len(entries), "created", len(keyMap))
  828. }
  829. return allData, bundleOverrides, nil
  830. }
  831. // registerRemoteKeys checks for duplicate remote keys across dataTo entries and
  832. // records new mappings. Returns an error if a duplicate is found.
  833. func registerRemoteKeys(seen, keyMap map[string]string, index int) error {
  834. for sourceKey, remoteKey := range keyMap {
  835. if existingSource, exists := seen[remoteKey]; exists {
  836. return fmt.Errorf("dataTo[%d]: duplicate remote key %q from source key %q (conflicts with %s)", index, remoteKey, sourceKey, existingSource)
  837. }
  838. seen[remoteKey] = fmt.Sprintf("dataTo[%d]:%s", index, sourceKey)
  839. }
  840. return nil
  841. }
  842. // recordBundleOverrides associates filtered data with bundle entries so only
  843. // matched keys appear in the pushed JSON blob.
  844. func recordBundleOverrides(overrides map[string]map[string][]byte, entries []esapi.PushSecretData, filteredData map[string][]byte) {
  845. if filteredData == nil {
  846. return
  847. }
  848. for _, entry := range entries {
  849. overrides[statusRef(entry)] = filteredData
  850. }
  851. }
  852. // expandSingleDataTo processes a single dataTo entry: converts keys, matches them
  853. // against the pattern, applies rewrites, validates remote keys, and builds the
  854. // resulting PushSecretData entries along with the source-to-remote key mapping.
  855. //
  856. // Bundle mode: when dataTo.RemoteKey is set, all matched keys are bundled into a
  857. // single PushSecretData entry with SecretKey="" targeting dataTo.RemoteKey. The
  858. // third return value carries the filtered (matched+converted) key data so that
  859. // only matched keys appear in the JSON blob pushed to the provider.
  860. //
  861. // Per-key mode: when dataTo.RemoteKey is empty, one PushSecretData entry is
  862. // produced per matched key. The third return value is nil.
  863. func (r *Reconciler) expandSingleDataTo(secret *v1.Secret, dataTo esapi.PushSecretDataTo) ([]esapi.PushSecretData, map[string]string, map[string][]byte, error) {
  864. if dataTo.RemoteKey != "" && len(dataTo.Rewrite) > 0 {
  865. return nil, nil, nil, fmt.Errorf("remoteKey and rewrite are mutually exclusive: rewrite is only supported in per-key mode (without remoteKey)")
  866. }
  867. convertedData, err := esutils.ReverseKeys(dataTo.ConversionStrategy, secret.Data)
  868. if err != nil {
  869. return nil, nil, nil, fmt.Errorf("conversion failed: %w", err)
  870. }
  871. // Map converted keys back to the original K8s secret keys. The resulting
  872. // PushSecretData entries store the original key so that
  873. // resolveSourceKeyConflicts can compare dataTo entries against explicit
  874. // data entries in the same key space. ConversionStrategy is set to None on
  875. // expanded entries because the conversion was already applied during
  876. // matching and rewriting; handlePushSecretDataForStore will look up the
  877. // original key directly in the unconverted secret data.
  878. convertedToOriginal := make(map[string]string, len(secret.Data))
  879. for origKey := range secret.Data {
  880. convKey := esutils.ReverseKey(dataTo.ConversionStrategy, origKey)
  881. convertedToOriginal[convKey] = origKey
  882. }
  883. allKeys := make([]string, 0, len(convertedData))
  884. for key := range convertedData {
  885. allKeys = append(allKeys, key)
  886. }
  887. slices.Sort(allKeys)
  888. matchedKeys, err := matchKeys(allKeys, dataTo.Match)
  889. if err != nil {
  890. return nil, nil, nil, fmt.Errorf("match failed: %w", err)
  891. }
  892. if len(matchedKeys) == 0 {
  893. return nil, nil, nil, nil
  894. }
  895. matchedData := make(map[string][]byte, len(matchedKeys))
  896. for _, key := range matchedKeys {
  897. matchedData[key] = convertedData[key]
  898. }
  899. if dataTo.RemoteKey != "" {
  900. keyMap := map[string]string{bundleSourceKey: dataTo.RemoteKey}
  901. entry := esapi.PushSecretData{
  902. Match: esapi.PushSecretMatch{
  903. SecretKey: "",
  904. RemoteRef: esapi.PushSecretRemoteRef{
  905. RemoteKey: dataTo.RemoteKey,
  906. },
  907. },
  908. Metadata: dataTo.Metadata,
  909. ConversionStrategy: esapi.PushSecretConversionNone,
  910. }
  911. return []esapi.PushSecretData{entry}, keyMap, matchedData, nil
  912. }
  913. keyMap, err := rewriteWithKeyMapping(dataTo.Rewrite, matchedData)
  914. if err != nil {
  915. return nil, nil, nil, fmt.Errorf("rewrite failed: %w", err)
  916. }
  917. for sourceKey, remoteKey := range keyMap {
  918. if remoteKey == "" {
  919. return nil, nil, nil, fmt.Errorf("empty remote key produced for source key %q", sourceKey)
  920. }
  921. }
  922. sortedKeys := slices.Sorted(maps.Keys(keyMap))
  923. entries := make([]esapi.PushSecretData, 0, len(keyMap))
  924. for _, convertedKey := range sortedKeys {
  925. entries = append(entries, esapi.PushSecretData{
  926. Match: esapi.PushSecretMatch{
  927. SecretKey: convertedToOriginal[convertedKey],
  928. RemoteRef: esapi.PushSecretRemoteRef{
  929. RemoteKey: keyMap[convertedKey],
  930. },
  931. },
  932. Metadata: dataTo.Metadata,
  933. ConversionStrategy: esapi.PushSecretConversionNone,
  934. })
  935. }
  936. return entries, keyMap, nil, nil
  937. }
  938. // validateDataToStoreRefs checks that each dataTo entry has a valid storeRef.
  939. func validateDataToStoreRefs(dataToList []esapi.PushSecretDataTo, storeRefs []esapi.PushSecretStoreRef) error {
  940. for i, d := range dataToList {
  941. if d.StoreRef == nil {
  942. return fmt.Errorf("dataTo[%d]: storeRef is required", i)
  943. }
  944. if d.StoreRef.Name == "" && d.StoreRef.LabelSelector == nil {
  945. return fmt.Errorf("dataTo[%d]: storeRef must have name or labelSelector", i)
  946. }
  947. if d.StoreRef.Name != "" && !storeRefExistsInList(d.StoreRef, storeRefs) {
  948. return fmt.Errorf("dataTo[%d]: storeRef %q not found in secretStoreRefs", i, d.StoreRef.Name)
  949. }
  950. }
  951. return nil
  952. }
  953. // storeRefExistsInList checks if a named ref matches any named entry in storeRefs.
  954. func storeRefExistsInList(ref *esapi.PushSecretStoreRef, storeRefs []esapi.PushSecretStoreRef) bool {
  955. refKind := ref.Kind
  956. if refKind == "" {
  957. refKind = esv1.SecretStoreKind
  958. }
  959. for _, sr := range storeRefs {
  960. if sr.Name == "" {
  961. continue
  962. }
  963. srKind := sr.Kind
  964. if srKind == "" {
  965. srKind = esv1.SecretStoreKind
  966. }
  967. if srKind == refKind && sr.Name == ref.Name {
  968. return true
  969. }
  970. }
  971. return false
  972. }
  973. func resolvedStoreInfo(ref esapi.PushSecretStoreRef, store any) (storeInfo, bool) {
  974. if genericStore, ok := store.(esv1.GenericStore); ok {
  975. kind := resolvedPushStoreKind(ref.Kind, genericStore)
  976. return storeInfo{
  977. Name: genericStore.GetName(),
  978. Kind: kind,
  979. Labels: genericStore.GetLabels(),
  980. }, true
  981. }
  982. if obj, ok := store.(client.Object); ok {
  983. kind := resolvedPushStoreKind(ref.Kind, obj)
  984. return storeInfo{
  985. Name: obj.GetName(),
  986. Kind: kind,
  987. Labels: obj.GetLabels(),
  988. }, true
  989. }
  990. return storeInfo{}, false
  991. }
  992. func resolvedPushStoreKind(refKind string, store any) string {
  993. if refKind != "" {
  994. return refKind
  995. }
  996. if genericStore, ok := store.(esv1.GenericStore); ok {
  997. return genericStore.GetKind()
  998. }
  999. switch store.(type) {
  1000. case *esv1.Provider:
  1001. return esv1.ProviderKindStr
  1002. case *esv1.ClusterProvider:
  1003. return esv1.ClusterProviderKindStr
  1004. default:
  1005. return esv1.SecretStoreKind
  1006. }
  1007. }
  1008. // validateDataToMatchesResolvedStores checks that every dataTo entry with a
  1009. // labelSelector actually matches at least one resolved store. Without this,
  1010. // a misconfigured labelSelector silently becomes a no-op.
  1011. func validateDataToMatchesResolvedStores(dataToList []esapi.PushSecretDataTo, stores []storeInfo) error {
  1012. for i, dataTo := range dataToList {
  1013. if dataTo.StoreRef == nil || dataTo.StoreRef.LabelSelector == nil {
  1014. continue
  1015. }
  1016. if dataTo.StoreRef.Name != "" {
  1017. continue
  1018. }
  1019. selector, err := metav1.LabelSelectorAsSelector(dataTo.StoreRef.LabelSelector)
  1020. if err != nil {
  1021. return fmt.Errorf("dataTo[%d]: invalid labelSelector: %w", i, err)
  1022. }
  1023. refKind := dataTo.StoreRef.Kind
  1024. if refKind == "" {
  1025. refKind = esv1.SecretStoreKind
  1026. }
  1027. if !anyStoreMatchesSelector(refKind, selector, stores) {
  1028. return fmt.Errorf("dataTo[%d]: labelSelector does not match any store in secretStoreRefs", i)
  1029. }
  1030. }
  1031. return nil
  1032. }
  1033. // anyStoreMatchesSelector returns true if at least one resolved store matches
  1034. // the given kind and label selector.
  1035. func anyStoreMatchesSelector(kind string, selector labels.Selector, stores []storeInfo) bool {
  1036. for _, store := range stores {
  1037. if store.Kind == kind && selector.Matches(labels.Set(store.Labels)) {
  1038. return true
  1039. }
  1040. }
  1041. return false
  1042. }
  1043. // rewriteWithKeyMapping applies rewrites and returns originalKey -> rewrittenKey mapping.
  1044. func rewriteWithKeyMapping(rewrites []esapi.PushSecretRewrite, data map[string][]byte) (map[string]string, error) {
  1045. keyMap := make(map[string]string, len(data))
  1046. for k := range data {
  1047. keyMap[k] = k
  1048. }
  1049. for i, op := range rewrites {
  1050. applyFn, err := compileRewrite(op)
  1051. if err != nil {
  1052. return nil, fmt.Errorf("rewrite[%d]: %w", i, err)
  1053. }
  1054. newKeyMap := make(map[string]string, len(keyMap))
  1055. for origKey, currentKey := range keyMap {
  1056. newKey, err := applyFn(currentKey)
  1057. if err != nil {
  1058. return nil, fmt.Errorf("rewrite[%d] on key %q: %w", i, currentKey, err)
  1059. }
  1060. newKeyMap[origKey] = newKey
  1061. }
  1062. keyMap = newKeyMap
  1063. }
  1064. return keyMap, nil
  1065. }
  1066. // compileRewrite pre-compiles a rewrite operation (regexp or template) and
  1067. // returns a function that applies it to a key. This avoids re-compiling the
  1068. // same regexp or re-parsing the same template for every key.
  1069. func compileRewrite(op esapi.PushSecretRewrite) (func(string) (string, error), error) {
  1070. switch {
  1071. case op.Regexp != nil:
  1072. re, err := regexp.Compile(op.Regexp.Source)
  1073. if err != nil {
  1074. return nil, fmt.Errorf("invalid regexp %q: %w", op.Regexp.Source, err)
  1075. }
  1076. target := op.Regexp.Target
  1077. return func(key string) (string, error) {
  1078. return re.ReplaceAllString(key, target), nil
  1079. }, nil
  1080. case op.Transform != nil:
  1081. tmpl, err := template.New("t").Funcs(estemplate.FuncMap()).Parse(op.Transform.Template)
  1082. if err != nil {
  1083. return nil, fmt.Errorf("invalid template: %w", err)
  1084. }
  1085. return func(key string) (string, error) {
  1086. var buf bytes.Buffer
  1087. if err := tmpl.Execute(&buf, map[string]string{"value": key}); err != nil {
  1088. return "", fmt.Errorf("template exec: %w", err)
  1089. }
  1090. return buf.String(), nil
  1091. }, nil
  1092. default:
  1093. return func(key string) (string, error) { return key, nil }, nil
  1094. }
  1095. }
  1096. // resolveSourceKeyConflicts merges dataTo and explicit data entries.
  1097. // When both reference the same source secret key, explicit data wins.
  1098. // Comparison is done using the original (raw) K8s secret key. DataTo entries
  1099. // already store the original key; explicit data entries may store a converted
  1100. // key when ConversionStrategy is set, so we normalize them via the secret.
  1101. func resolveSourceKeyConflicts(dataToEntries, explicitData []esapi.PushSecretData, secret *v1.Secret) []esapi.PushSecretData {
  1102. explicitOriginalKeys := make(map[string]struct{}, len(explicitData))
  1103. for _, data := range explicitData {
  1104. origKey := resolveOriginalKey(data, secret)
  1105. explicitOriginalKeys[origKey] = struct{}{}
  1106. }
  1107. result := make([]esapi.PushSecretData, 0, len(dataToEntries)+len(explicitData))
  1108. for _, data := range dataToEntries {
  1109. if _, exists := explicitOriginalKeys[data.GetSecretKey()]; !exists {
  1110. result = append(result, data)
  1111. }
  1112. }
  1113. return append(result, explicitData...)
  1114. }
  1115. // resolveOriginalKey returns the raw K8s secret key for a PushSecretData entry.
  1116. // If the entry uses a ConversionStrategy, SecretKey is the converted (decoded)
  1117. // form, so we find the original key by converting each raw key and matching.
  1118. // If no conversion is active, SecretKey is already the original key.
  1119. func resolveOriginalKey(data esapi.PushSecretData, secret *v1.Secret) string {
  1120. key := data.GetSecretKey()
  1121. if data.ConversionStrategy == "" || data.ConversionStrategy == esapi.PushSecretConversionNone {
  1122. return key
  1123. }
  1124. for origKey := range secret.Data {
  1125. if esutils.ReverseKey(data.ConversionStrategy, origKey) == key {
  1126. return origKey
  1127. }
  1128. }
  1129. return key
  1130. }
  1131. // validateRemoteKeyUniqueness ensures no two entries push to the same remote location.
  1132. // The remote location is defined by (remoteKey, property) tuple.
  1133. func validateRemoteKeyUniqueness(entries []esapi.PushSecretData) error {
  1134. type remoteLocation struct {
  1135. remoteKey string
  1136. property string
  1137. }
  1138. seen := make(map[remoteLocation]string) // location -> source key (for error message)
  1139. for _, data := range entries {
  1140. loc := remoteLocation{
  1141. remoteKey: data.GetRemoteKey(),
  1142. property: data.GetProperty(),
  1143. }
  1144. sourceKey := data.GetSecretKey()
  1145. if existingSource, exists := seen[loc]; exists {
  1146. if loc.property != "" {
  1147. return fmt.Errorf(
  1148. "duplicate remote key %q with property %q: source keys %q and %q both map to the same destination",
  1149. loc.remoteKey, loc.property, existingSource, sourceKey)
  1150. }
  1151. return fmt.Errorf(
  1152. "duplicate remote key %q: source keys %q and %q both map to the same destination",
  1153. loc.remoteKey, existingSource, sourceKey)
  1154. }
  1155. seen[loc] = sourceKey
  1156. }
  1157. return nil
  1158. }
  1159. // mergeDataEntries combines dataTo and explicit data entries.
  1160. // It resolves source key conflicts (explicit wins) and validates no duplicate remote destinations.
  1161. func mergeDataEntries(dataToEntries, explicitData []esapi.PushSecretData, secret *v1.Secret) ([]esapi.PushSecretData, error) {
  1162. merged := resolveSourceKeyConflicts(dataToEntries, explicitData, secret)
  1163. if err := validateRemoteKeyUniqueness(merged); err != nil {
  1164. return nil, err
  1165. }
  1166. return merged, nil
  1167. }