/* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package externalsecret import ( "context" "encoding/json" "errors" "fmt" "strings" "time" "github.com/go-logr/logr" "github.com/prometheus/client_golang/prometheus" v1 "k8s.io/api/core/v1" "k8s.io/apimachinery/pkg/api/equality" apierrors "k8s.io/apimachinery/pkg/api/errors" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/types" "k8s.io/client-go/tools/record" ctrl "sigs.k8s.io/controller-runtime" "sigs.k8s.io/controller-runtime/pkg/builder" "sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/controller-runtime/pkg/controller" "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil" esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1" "github.com/external-secrets/external-secrets/pkg/controllers/secretstore" // Loading registered providers. _ "github.com/external-secrets/external-secrets/pkg/provider/register" "github.com/external-secrets/external-secrets/pkg/utils" ) const ( requeueAfter = time.Second * 30 fieldOwnerTemplate = "externalsecrets.external-secrets.io/%v" errGetES = "could not get ExternalSecret" errConvert = "could not apply conversion strategy to keys: %v" errUpdateSecret = "could not update Secret" errPatchStatus = "unable to patch status" errGetSecretStore = "could not get SecretStore %q, %w" errGetClusterSecretStore = "could not get ClusterSecretStore %q, %w" errStoreRef = "could not get store reference" errStoreProvider = "could not get store provider" errStoreClient = "could not get provider client" errGetExistingSecret = "could not get existing secret: %w" errCloseStoreClient = "could not close provider client" errSetCtrlReference = "could not set ExternalSecret controller reference: %w" errFetchTplFrom = "error fetching templateFrom data: %w" errGetSecretData = "could not get secret data from provider" errDeleteSecret = "could not delete secret" errApplyTemplate = "could not apply template: %w" errExecTpl = "could not execute template: %w" errInvalidCreatePolicy = "invalid creationPolicy=%s. Can not delete secret i do not own" errPolicyMergeNotFound = "the desired secret %s was not found. With creationPolicy=Merge the secret won't be created" errPolicyMergeGetSecret = "unable to get secret %s: %w" errPolicyMergeMutate = "unable to mutate secret %s: %w" errPolicyMergePatch = "unable to patch secret %s: %w" errTplCMMissingKey = "error in configmap %s: missing key %s" errTplSecMissingKey = "error in secret %s: missing key %s" ) // Reconciler reconciles a ExternalSecret object. type Reconciler struct { client.Client Log logr.Logger Scheme *runtime.Scheme ControllerClass string RequeueInterval time.Duration ClusterSecretStoreEnabled bool recorder record.EventRecorder } // Reconcile implements the main reconciliation loop // for watched objects (ExternalSecret, ClusterSecretStore and SecretStore), // and updates/creates a Kubernetes secret based on them. func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { log := r.Log.WithValues("ExternalSecret", req.NamespacedName) syncCallsMetricLabels := prometheus.Labels{"name": req.Name, "namespace": req.Namespace} var externalSecret esv1beta1.ExternalSecret err := r.Get(ctx, req.NamespacedName, &externalSecret) if apierrors.IsNotFound(err) { syncCallsTotal.With(syncCallsMetricLabels).Inc() conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretDeleted, v1.ConditionFalse, esv1beta1.ConditionReasonSecretDeleted, "Secret was deleted") SetExternalSecretCondition(&esv1beta1.ExternalSecret{ ObjectMeta: metav1.ObjectMeta{ Name: req.Name, Namespace: req.Namespace, }, }, *conditionSynced) return ctrl.Result{}, nil } else if err != nil { log.Error(err, errGetES) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{}, nil } if shouldSkipClusterSecretStore(r, externalSecret) { log.Info("skipping cluster secret store as it is disabled") return ctrl.Result{}, nil } // patch status when done processing p := client.MergeFrom(externalSecret.DeepCopy()) defer func() { err = r.Status().Patch(ctx, &externalSecret, p) if err != nil { log.Error(err, errPatchStatus) } }() store, err := r.getStore(ctx, &externalSecret) if err != nil { log.Error(err, errStoreRef) r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonInvalidStoreRef, err.Error()) conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errStoreRef) SetExternalSecretCondition(&externalSecret, *conditionSynced) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{RequeueAfter: requeueAfter}, nil } log = log.WithValues("SecretStore", store.GetNamespacedName()) // check if store should be handled by this controller instance if !secretstore.ShouldProcessStore(store, r.ControllerClass) { log.Info("skipping unmanaged store") return ctrl.Result{}, nil } storeProvider, err := esv1beta1.GetProvider(store) if err != nil { log.Error(err, errStoreProvider) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{RequeueAfter: requeueAfter}, nil } secretClient, err := storeProvider.NewClient(ctx, store, r.Client, req.Namespace) if err != nil { log.Error(err, errStoreClient) conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errStoreClient) SetExternalSecretCondition(&externalSecret, *conditionSynced) r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonProviderClientConfig, err.Error()) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{RequeueAfter: requeueAfter}, nil } defer func() { err = secretClient.Close(ctx) if err != nil { log.Error(err, errCloseStoreClient) } }() refreshInt := r.RequeueInterval if externalSecret.Spec.RefreshInterval != nil { refreshInt = externalSecret.Spec.RefreshInterval.Duration } // Target Secret Name should default to the ExternalSecret name if not explicitly specified secretName := externalSecret.Spec.Target.Name if secretName == "" { secretName = externalSecret.ObjectMeta.Name } // fetch external secret, we need to ensure that it exists, and it's hashmap corresponds var existingSecret v1.Secret err = r.Get(ctx, types.NamespacedName{ Name: secretName, Namespace: externalSecret.Namespace, }, &existingSecret) if err != nil && !apierrors.IsNotFound(err) { log.Error(err, errGetExistingSecret) } // refresh should be skipped if // 1. resource generation hasn't changed // 2. refresh interval is 0 // 3. if we're still within refresh-interval if !shouldRefresh(externalSecret) && isSecretValid(existingSecret) { log.V(1).Info("skipping refresh", "rv", getResourceVersion(externalSecret)) return ctrl.Result{RequeueAfter: refreshInt}, nil } if !shouldReconcile(externalSecret) { log.V(1).Info("stopping reconciling", "rv", getResourceVersion(externalSecret)) return ctrl.Result{ RequeueAfter: 0, Requeue: false, }, nil } secret := &v1.Secret{ ObjectMeta: metav1.ObjectMeta{ Name: secretName, Namespace: externalSecret.Namespace, }, Immutable: &externalSecret.Spec.Target.Immutable, Data: make(map[string][]byte), } dataMap, err := r.getProviderSecretData(ctx, secretClient, &externalSecret) if err != nil { log.Error(err, errGetSecretData) r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error()) conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errGetSecretData) SetExternalSecretCondition(&externalSecret, *conditionSynced) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{RequeueAfter: requeueAfter}, nil } // if no data was found we can delete the secret if needed. if len(dataMap) == 0 { switch externalSecret.Spec.Target.DeletionPolicy { // delete secret and return early. case esv1beta1.DeletionPolicyDelete: // safeguard that we only can delete secrets we own // this is also implemented in the es validation webhook if externalSecret.Spec.Target.CreationPolicy != esv1beta1.CreatePolicyOwner { err := fmt.Errorf(errInvalidCreatePolicy, externalSecret.Spec.Target.CreationPolicy) log.Error(err, errDeleteSecret) r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error()) conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret) SetExternalSecretCondition(&externalSecret, *conditionSynced) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{RequeueAfter: requeueAfter}, nil } err = r.Delete(ctx, secret) if err != nil && !apierrors.IsNotFound(err) { log.Error(err, errDeleteSecret) r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error()) conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errDeleteSecret) SetExternalSecretCondition(&externalSecret, *conditionSynced) syncCallsError.With(syncCallsMetricLabels).Inc() } conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretDeleted, "secret deleted due to DeletionPolicy") SetExternalSecretCondition(&externalSecret, *conditionSynced) return ctrl.Result{RequeueAfter: requeueAfter}, nil case esv1beta1.DeletionPolicyMerge: // noop, handled below // In case provider secrets don't exist the kubernetes secret will be kept as-is. case esv1beta1.DeletionPolicyRetain: return ctrl.Result{RequeueAfter: requeueAfter}, nil } } mutationFunc := func() error { if externalSecret.Spec.Target.CreationPolicy == esv1beta1.CreatePolicyOwner { err = controllerutil.SetControllerReference(&externalSecret, &secret.ObjectMeta, r.Scheme) if err != nil { return fmt.Errorf(errSetCtrlReference, err) } } if secret.Data == nil { secret.Data = make(map[string][]byte) } err = r.applyTemplate(ctx, &externalSecret, secret, dataMap) if err != nil { return fmt.Errorf(errApplyTemplate, err) } // diff existing keys if externalSecret.Spec.Target.DeletionPolicy == esv1beta1.DeletionPolicyMerge { keys, err := getManagedKeys(&existingSecret, externalSecret.Name) if err != nil { return err } for _, key := range keys { if dataMap[key] == nil { secret.Data[key] = nil } } } return nil } // nolint switch externalSecret.Spec.Target.CreationPolicy { case esv1beta1.CreatePolicyMerge: err = patchSecret(ctx, r.Client, r.Scheme, secret, mutationFunc, externalSecret.Name) case esv1beta1.CreatePolicyNone: log.V(1).Info("secret creation skipped due to creationPolicy=None") err = nil default: _, err = ctrl.CreateOrUpdate(ctx, r.Client, secret, mutationFunc) } if err != nil { log.Error(err, errUpdateSecret) r.recorder.Event(&externalSecret, v1.EventTypeWarning, esv1beta1.ReasonUpdateFailed, err.Error()) conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionFalse, esv1beta1.ConditionReasonSecretSyncedError, errUpdateSecret) SetExternalSecretCondition(&externalSecret, *conditionSynced) syncCallsError.With(syncCallsMetricLabels).Inc() return ctrl.Result{}, err } r.recorder.Event(&externalSecret, v1.EventTypeNormal, esv1beta1.ReasonUpdated, "Updated Secret") conditionSynced := NewExternalSecretCondition(esv1beta1.ExternalSecretReady, v1.ConditionTrue, esv1beta1.ConditionReasonSecretSynced, "Secret was synced") currCond := GetExternalSecretCondition(externalSecret.Status, esv1beta1.ExternalSecretReady) SetExternalSecretCondition(&externalSecret, *conditionSynced) externalSecret.Status.RefreshTime = metav1.NewTime(time.Now()) externalSecret.Status.SyncedResourceVersion = getResourceVersion(externalSecret) syncCallsTotal.With(syncCallsMetricLabels).Inc() if currCond == nil || currCond.Status != conditionSynced.Status { log.Info("reconciled secret") // Log once if on success in any verbosity } else { log.V(1).Info("reconciled secret") // Log all reconciliation cycles if higher verbosity applied } return ctrl.Result{ RequeueAfter: refreshInt, }, nil } func patchSecret(ctx context.Context, c client.Client, scheme *runtime.Scheme, secret *v1.Secret, mutationFunc func() error, fieldOwner string) error { fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner) err := c.Get(ctx, client.ObjectKeyFromObject(secret), secret.DeepCopy()) if apierrors.IsNotFound(err) { return fmt.Errorf(errPolicyMergeNotFound, secret.Name) } if err != nil { return fmt.Errorf(errPolicyMergeGetSecret, secret.Name, err) } existing := secret.DeepCopyObject() err = mutationFunc() if err != nil { return fmt.Errorf(errPolicyMergeMutate, secret.Name, err) } // GVK is missing in the Secret, see: // https://github.com/kubernetes-sigs/controller-runtime/issues/526 // https://github.com/kubernetes-sigs/controller-runtime/issues/1517 // https://github.com/kubernetes/kubernetes/issues/80609 // we need to manually set it before doing a Patch() as it depends on the GVK gvks, unversioned, err := scheme.ObjectKinds(secret) if err != nil { return err } if !unversioned && len(gvks) == 1 { secret.SetGroupVersionKind(gvks[0]) } if equality.Semantic.DeepEqual(existing, secret) { return nil } // we're not able to resolve conflicts so we force ownership // see: https://kubernetes.io/docs/reference/using-api/server-side-apply/#using-server-side-apply-in-a-controller err = c.Patch(ctx, secret, client.Apply, client.FieldOwner(fqdn), client.ForceOwnership) if err != nil { return fmt.Errorf(errPolicyMergePatch, secret.Name, err) } return nil } func getManagedKeys(secret *v1.Secret, fieldOwner string) ([]string, error) { fqdn := fmt.Sprintf(fieldOwnerTemplate, fieldOwner) var keys []string for _, v := range secret.ObjectMeta.ManagedFields { if v.Manager != fqdn { continue } fields := make(map[string]interface{}) err := json.Unmarshal(v.FieldsV1.Raw, &fields) if err != nil { return nil, fmt.Errorf("error unmarshaling managed fields: %w", err) } dataFields := fields["f:data"] if dataFields == nil { continue } df, ok := dataFields.(map[string]string) if !ok { continue } for k := range df { if k == "." { continue } keys = append(keys, strings.TrimPrefix(k, "f:")) } } return keys, nil } func getResourceVersion(es esv1beta1.ExternalSecret) string { return fmt.Sprintf("%d-%s", es.ObjectMeta.GetGeneration(), hashMeta(es.ObjectMeta)) } func hashMeta(m metav1.ObjectMeta) string { type meta struct { annotations map[string]string labels map[string]string } return utils.ObjectHash(meta{ annotations: m.Annotations, labels: m.Labels, }) } func shouldSkipClusterSecretStore(r *Reconciler, es esv1beta1.ExternalSecret) bool { return !r.ClusterSecretStoreEnabled && es.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind } func shouldRefresh(es esv1beta1.ExternalSecret) bool { // refresh if resource version changed if es.Status.SyncedResourceVersion != getResourceVersion(es) { return true } // skip refresh if refresh interval is 0 if es.Spec.RefreshInterval.Duration == 0 && es.Status.SyncedResourceVersion != "" { return false } if es.Status.RefreshTime.IsZero() { return true } return !es.Status.RefreshTime.Add(es.Spec.RefreshInterval.Duration).After(time.Now()) } func shouldReconcile(es esv1beta1.ExternalSecret) bool { if es.Spec.Target.Immutable && hasSyncedCondition(es) { return false } return true } func hasSyncedCondition(es esv1beta1.ExternalSecret) bool { for _, condition := range es.Status.Conditions { if condition.Reason == "SecretSynced" { return true } } return false } // isSecretValid checks if the secret exists, and it's data is consistent with the calculated hash. func isSecretValid(existingSecret v1.Secret) bool { // if target secret doesn't exist, or annotations as not set, we need to refresh if existingSecret.UID == "" || existingSecret.Annotations == nil { return false } // if the calculated hash is different from the calculation, then it's invalid if existingSecret.Annotations[esv1beta1.AnnotationDataHash] != utils.ObjectHash(existingSecret.Data) { return false } return true } // getStore returns the store with the provided ExternalSecret. func (r *Reconciler) getStore(ctx context.Context, externalSecret *esv1beta1.ExternalSecret) (esv1beta1.GenericStore, error) { ref := types.NamespacedName{ Name: externalSecret.Spec.SecretStoreRef.Name, } if externalSecret.Spec.SecretStoreRef.Kind == esv1beta1.ClusterSecretStoreKind { var store esv1beta1.ClusterSecretStore err := r.Get(ctx, ref, &store) if err != nil { return nil, fmt.Errorf(errGetClusterSecretStore, ref.Name, err) } return &store, nil } ref.Namespace = externalSecret.Namespace var store esv1beta1.SecretStore err := r.Get(ctx, ref, &store) if err != nil { return nil, fmt.Errorf(errGetSecretStore, ref.Name, err) } return &store, nil } // getProviderSecretData returns the provider's secret data with the provided ExternalSecret. func (r *Reconciler) getProviderSecretData(ctx context.Context, providerClient esv1beta1.SecretsClient, externalSecret *esv1beta1.ExternalSecret) (map[string][]byte, error) { providerData := make(map[string][]byte) for i, remoteRef := range externalSecret.Spec.DataFrom { var secretMap map[string][]byte var err error if remoteRef.Find != nil { secretMap, err = providerClient.GetAllSecrets(ctx, *remoteRef.Find) if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain { r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonDeleted, fmt.Sprintf("secret does not exist at provider using .dataFrom[%d]", i)) continue } if err != nil { return nil, err } secretMap, err = utils.ConvertKeys(remoteRef.Find.ConversionStrategy, secretMap) if err != nil { return nil, fmt.Errorf(errConvert, err) } } else if remoteRef.Extract != nil { secretMap, err = providerClient.GetSecretMap(ctx, *remoteRef.Extract) if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain { r.recorder.Event(externalSecret, v1.EventTypeNormal, esv1beta1.ReasonDeleted, fmt.Sprintf("secret does not exist at provider using .dataFrom[%d]", i)) continue } if err != nil { return nil, err } secretMap, err = utils.ConvertKeys(remoteRef.Extract.ConversionStrategy, secretMap) if err != nil { return nil, fmt.Errorf(errConvert, err) } } providerData = utils.MergeByteMap(providerData, secretMap) } for i, secretRef := range externalSecret.Spec.Data { secretData, err := providerClient.GetSecret(ctx, secretRef.RemoteRef) if errors.Is(err, esv1beta1.NoSecretErr) && externalSecret.Spec.Target.DeletionPolicy != esv1beta1.DeletionPolicyRetain { 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)) continue } if err != nil { return nil, err } providerData[secretRef.SecretKey] = secretData } return providerData, nil } // SetupWithManager returns a new controller builder that will be started by the provided Manager. func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error { r.recorder = mgr.GetEventRecorderFor("external-secrets") return ctrl.NewControllerManagedBy(mgr). WithOptions(opts). For(&esv1beta1.ExternalSecret{}). Owns(&v1.Secret{}, builder.OnlyMetadata). Complete(r) }