certServiceK8sExternalProvider/src/cmpv2controller/cmpv2_issuer_controller.go

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * oom-certservice-k8s-external-provider
   4  * ================================================================================
   5  * Copyright (c) 2019 Smallstep Labs, Inc.
   6  * Modifications copyright (C) 2020 Nokia. All rights reserved.
   7  * ================================================================================
   8  * This source code was copied from the following git repository:
   9  * https://github.com/smallstep/step-issuer
  10  * The source code was modified for usage in the ONAP project.
  11  * ================================================================================
  12  * Licensed under the Apache License, Version 2.0 (the "License");
  13  * you may not use this file except in compliance with the License.
  14  * You may obtain a copy of the License at
  15  *
  16  *      http://www.apache.org/licenses/LICENSE-2.0
  17  *
  18  * Unless required by applicable law or agreed to in writing, software
  19  * distributed under the License is distributed on an "AS IS" BASIS,
  20  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21  * See the License for the specific language governing permissions and
  22  * limitations under the License.
  23  * ============LICENSE_END=========================================================
  24  */
  25
  26 package cmpv2controller
  27
  28 import (
  29         "context"
  30         "fmt"
  31
  32         "github.com/go-logr/logr"
  33         core "k8s.io/api/core/v1"
  34         apierrors "k8s.io/apimachinery/pkg/api/errors"
  35         "k8s.io/apimachinery/pkg/runtime"
  36         "k8s.io/apimachinery/pkg/types"
  37         "k8s.io/client-go/tools/record"
  38         "k8s.io/utils/clock"
  39         ctrl "sigs.k8s.io/controller-runtime"
  40         "sigs.k8s.io/controller-runtime/pkg/client"
  41
  42         "onap.org/oom-certservice/k8s-external-provider/src/cmpv2api"
  43         provisioners "onap.org/oom-certservice/k8s-external-provider/src/cmpv2provisioner"
  44 )
  45
  46 // CMPv2IssuerController reconciles a CMPv2Issuer object
  47 type CMPv2IssuerController struct {
  48         client.Client
  49         Log      logr.Logger
  50         Clock    clock.Clock
  51         Recorder record.EventRecorder
  52 }
  53
  54 // Reconcile will read and validate the CMPv2Issuer resources, it will set the
  55 // status condition ready to true if everything is right.
  56 func (controller *CMPv2IssuerController) Reconcile(req ctrl.Request) (ctrl.Result, error) {
  57         ctx := context.Background()
  58         log := controller.Log.WithValues("cmpv2-issuer-controller", req.NamespacedName)
  59
  60         // 1. Load CMPv2Issuer
  61         issuer := new(cmpv2api.CMPv2Issuer)
  62         if err := controller.loadResource(ctx, req.NamespacedName, issuer); err != nil {
  63                 handleErrorLoadingCMPv2Issuer(log, err)
  64                 return ctrl.Result{}, client.IgnoreNotFound(err)
  65         }
  66         log.Info("CMPv2Issuer loaded: ", "issuer", issuer)
  67
  68         // 2. Validate CMPv2Issuer
  69         statusUpdater := newStatusUpdater(controller, issuer, log)
  70         if err := validateCMPv2IssuerSpec(issuer.Spec, log); err != nil {
  71                 handleErrorCMPv2IssuerValidation(ctx, log, err, statusUpdater)
  72                 return ctrl.Result{}, err
  73         }
  74
  75         // 3. Load keystore and truststore information form k8s secret
  76         var secret core.Secret
  77         secretNamespaceName := types.NamespacedName{
  78                 Namespace: req.Namespace,
  79                 Name:      issuer.Spec.CertSecretRef.Name,
  80         }
  81         if err := controller.loadResource(ctx, secretNamespaceName, &secret); err != nil {
  82                 handleErrorInvalidSecret(ctx, log, err, statusUpdater, secretNamespaceName)
  83                 return ctrl.Result{}, err
  84         }
  85
  86         // 4. Create CMPv2 provisioner
  87         provisioner, err := provisioners.CreateProvisioner(issuer, secret)
  88         if err != nil {
  89                 log.Error(err, "failed to initialize provisioner")
  90                 statusUpdater.UpdateNoError(ctx, cmpv2api.ConditionFalse, "Error", "Failed to initialize provisioner: %v", err)
  91                 handleErrorProvisionerInitialization(ctx, log, err, statusUpdater)
  92                 return ctrl.Result{}, err
  93         }
  94
  95         // 5. Check health of the provisioner and store the instance for further use
  96         if err := provisioner.CheckHealth(); err != nil {
  97                 return ctrl.Result{}, err
  98         }
  99         provisioners.Store(req.NamespacedName, provisioner)
 100
 101         // 6. Update the status of CMPv2Issuer to 'Validated'
 102         if err := updateCMPv2IssuerStatusToVerified(statusUpdater, ctx, log); err != nil {
 103                 handleErrorUpdatingCMPv2IssuerStatus(log, err)
 104                 return ctrl.Result{}, err
 105         }
 106
 107         return ctrl.Result{}, nil
 108 }
 109
 110 func (controller *CMPv2IssuerController) SetupWithManager(manager ctrl.Manager) error {
 111         return ctrl.NewControllerManagedBy(manager).
 112                 For(&cmpv2api.CMPv2Issuer{}).
 113                 Complete(controller)
 114 }
 115
 116 func (controller *CMPv2IssuerController) loadResource(ctx context.Context, key client.ObjectKey, obj runtime.Object) error {
 117         return controller.Client.Get(ctx, key, obj)
 118 }
 119
 120 func validateCMPv2IssuerSpec(issuerSpec cmpv2api.CMPv2IssuerSpec, log logr.Logger) error {
 121         switch {
 122         case issuerSpec.URL == "":
 123                 return fmt.Errorf("spec.url cannot be empty")
 124         case issuerSpec.CaName == "":
 125                 return fmt.Errorf("spec.caName cannot be empty")
 126         case issuerSpec.CertSecretRef.Name == "":
 127                 return fmt.Errorf("spec.certSecretRef.name cannot be empty")
 128         case issuerSpec.CertSecretRef.KeyRef == "":
 129                 return fmt.Errorf("spec.certSecretRef.keyRef cannot be empty")
 130         case issuerSpec.CertSecretRef.CertRef == "":
 131                 return fmt.Errorf("spec.certSecretRef.certRef cannot be empty")
 132         case issuerSpec.CertSecretRef.CacertRef == "":
 133                 return fmt.Errorf("spec.certSecretRef.cacertRef cannot be empty")
 134         default:
 135                 return nil
 136         }
 137 }
 138
 139 func updateCMPv2IssuerStatusToVerified(statusUpdater *CMPv2IssuerStatusUpdater, ctx context.Context, log logr.Logger) error {
 140         log.Info("CMPv2 provisioner created -> updating status to of CMPv2Issuer resource to: Verified")
 141         return statusUpdater.Update(ctx, cmpv2api.ConditionTrue, Verified, "CMPv2Issuer verified and ready to sign certificates")
 142 }
 143
 144 // Error handling
 145
 146 func handleErrorUpdatingCMPv2IssuerStatus(log logr.Logger, err error) {
 147         log.Error(err, "Failed to update CMPv2Issuer status")
 148 }
 149
 150 func handleErrorLoadingCMPv2Issuer(log logr.Logger, err error) {
 151         log.Error(err, "Failed to retrieve CMPv2Issuer resource")
 152 }
 153
 154 func handleErrorProvisionerInitialization(ctx context.Context, log logr.Logger, err error, statusUpdater *CMPv2IssuerStatusUpdater) {
 155         log.Error(err, "Failed to initialize provisioner")
 156         statusUpdater.UpdateNoError(ctx, cmpv2api.ConditionFalse, Error, "Failed to initialize provisioner: %v", err)
 157 }
 158
 159 func handleErrorCMPv2IssuerValidation(ctx context.Context, log logr.Logger, err error, statusUpdater *CMPv2IssuerStatusUpdater) {
 160         log.Error(err, "Failed to validate CMPv2Issuer resource")
 161         statusUpdater.UpdateNoError(ctx, cmpv2api.ConditionFalse, ValidationFailed, "Failed to validate resource: %v", err)
 162 }
 163
 164 func handleErrorInvalidSecret(ctx context.Context, log logr.Logger, err error, statusUpdater *CMPv2IssuerStatusUpdater, secretNamespaceName types.NamespacedName) {
 165         log.Error(err, "Failed to retrieve CMPv2Issuer provisioner secret", "namespace", secretNamespaceName.Namespace, "name", secretNamespaceName.Name)
 166         if apierrors.IsNotFound(err) {
 167                 statusUpdater.UpdateNoError(ctx, cmpv2api.ConditionFalse, NotFound, "Failed to retrieve provisioner secret: %v", err)
 168         } else {
 169                 statusUpdater.UpdateNoError(ctx, cmpv2api.ConditionFalse, Error, "Failed to retrieve provisioner secret: %v", err)
 170         }
 171 }