certServiceK8sExternalProvider/src/cmpv2controller/certificate_request_controller.go

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * oom-certservice-k8s-external-provider
   4  * ================================================================================
   5  * Copyright 2019 The cert-manager authors.
   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         apiutil "github.com/jetstack/cert-manager/pkg/api/util"
  34         cmapi "github.com/jetstack/cert-manager/pkg/apis/certmanager/v1"
  35         cmmeta "github.com/jetstack/cert-manager/pkg/apis/meta/v1"
  36         core "k8s.io/api/core/v1"
  37         apierrors "k8s.io/apimachinery/pkg/api/errors"
  38         "k8s.io/apimachinery/pkg/types"
  39         "k8s.io/client-go/tools/record"
  40         ctrl "sigs.k8s.io/controller-runtime"
  41         "sigs.k8s.io/controller-runtime/pkg/client"
  42
  43         "onap.org/oom-certservice/k8s-external-provider/src/cmpv2api"
  44         "onap.org/oom-certservice/k8s-external-provider/src/cmpv2controller/logger"
  45         provisioners "onap.org/oom-certservice/k8s-external-provider/src/cmpv2provisioner"
  46         x509utils "onap.org/oom-certservice/k8s-external-provider/src/x509"
  47 )
  48
  49 const (
  50         privateKeySecretNameAnnotation = "cert-manager.io/private-key-secret-name"
  51         privateKeySecretKey = "tls.key"
  52 )
  53
  54 // CertificateRequestController reconciles a CMPv2Issuer object.
  55 type CertificateRequestController struct {
  56         client.Client
  57         Log      logr.Logger
  58         Recorder record.EventRecorder
  59 }
  60
  61 // Reconcile will read and validate a CMPv2Issuer resource associated to the
  62 // CertificateRequest resource, and it will sign the CertificateRequest with the
  63 // provisioner in the CMPv2Issuer.
  64 func (controller *CertificateRequestController) Reconcile(k8sRequest ctrl.Request) (ctrl.Result, error) {
  65         ctx := context.Background()
  66         log := controller.Log.WithValues("certificate-request-controller", k8sRequest.NamespacedName)
  67
  68         // 1. Fetch the CertificateRequest resource being reconciled.
  69         certificateRequest := new(cmapi.CertificateRequest)
  70         log.Info("Registered new certificate sign request: ", "cert-name", certificateRequest.Name)
  71         if err := controller.Client.Get(ctx, k8sRequest.NamespacedName, certificateRequest); err != nil {
  72                 err = handleErrorResourceNotFound(log, err)
  73                 return ctrl.Result{}, err
  74         }
  75
  76         // 2. Check if CertificateRequest is meant for CMPv2Issuer (if not ignore)
  77         if !isCMPv2CertificateRequest(certificateRequest) {
  78                 log.Info("Certificate request is not meant for CMPv2Issuer (ignoring)",
  79                         "group", certificateRequest.Spec.IssuerRef.Group,
  80                         "kind", certificateRequest.Spec.IssuerRef.Kind)
  81                 return ctrl.Result{}, nil
  82         }
  83
  84         // 3. If the certificate data is already set then we skip this request as it
  85         // has already been completed in the past.
  86         if len(certificateRequest.Status.Certificate) > 0 {
  87                 log.Info("Existing certificate data found in status, skipping already completed CertificateRequest")
  88                 return ctrl.Result{}, nil
  89         }
  90
  91         // 4. Fetch the CMPv2Issuer resource
  92         issuer := cmpv2api.CMPv2Issuer{}
  93         issuerNamespaceName := types.NamespacedName{
  94                 Namespace: k8sRequest.Namespace,
  95                 Name:      certificateRequest.Spec.IssuerRef.Name,
  96         }
  97         if err := controller.Client.Get(ctx, issuerNamespaceName, &issuer); err != nil {
  98                 controller.handleErrorGettingCMPv2Issuer(ctx, log, err, certificateRequest, issuerNamespaceName, k8sRequest)
  99                 return ctrl.Result{}, err
 100         }
 101
 102         // 5. Check if CMPv2Issuer is ready to sing certificates
 103         if !isCMPv2IssuerReady(issuer) {
 104                 err := controller.handleErrorCMPv2IssuerIsNotReady(ctx, log, issuerNamespaceName, certificateRequest, k8sRequest)
 105                 return ctrl.Result{}, err
 106         }
 107
 108         // 6. Load the provisioner that will sign the CertificateRequest
 109         provisioner, ok := provisioners.Load(issuerNamespaceName)
 110         if !ok {
 111                 err := controller.handleErrorCouldNotLoadCMPv2Provisioner(ctx, log, issuerNamespaceName, certificateRequest)
 112                 return ctrl.Result{}, err
 113         }
 114
 115         // 7. Get private key matching CertificateRequest
 116         privateKeySecretName := certificateRequest.ObjectMeta.Annotations[privateKeySecretNameAnnotation]
 117         privateKeySecretNamespaceName := types.NamespacedName{
 118                 Namespace: k8sRequest.Namespace,
 119                 Name:      privateKeySecretName,
 120         }
 121         var privateKeySecret core.Secret
 122         if err := controller.Client.Get(ctx, privateKeySecretNamespaceName, &privateKeySecret); err != nil {
 123                 controller.handleErrorGettingPrivateKey(ctx, log, err, certificateRequest, privateKeySecretNamespaceName)
 124                 return ctrl.Result{}, err
 125         }
 126         privateKeyBytes := privateKeySecret.Data[privateKeySecretKey]
 127
 128         // 8. Decode CSR
 129         log.Info("Decoding CSR...")
 130         csr, err := x509utils.DecodeCSR(certificateRequest.Spec.Request)
 131         if err != nil {
 132                 controller.handleErrorFailedToDecodeCSR(ctx, log, err, certificateRequest)
 133                 return ctrl.Result{}, err
 134         }
 135
 136         // 9. Log Certificate Request properties not supported or overridden by CertService API
 137         logger.LogCertRequestProperties(ctrl.Log.WithName("CSR details"), certificateRequest, csr)
 138
 139         // 10. Sign CertificateRequest
 140         signedPEM, trustedCAs, err := provisioner.Sign(ctx, certificateRequest, privateKeyBytes)
 141         if err != nil {
 142                 controller.handleErrorFailedToSignCertificate(ctx, log, err, certificateRequest)
 143                 return ctrl.Result{}, err
 144         }
 145
 146         // 11. Store signed certificates in CertificateRequest
 147         certificateRequest.Status.Certificate = signedPEM
 148         certificateRequest.Status.CA = trustedCAs
 149         if err := controller.updateCertificateRequestWithSignedCerficates(ctx, certificateRequest); err != nil {
 150                 return ctrl.Result{}, err
 151         }
 152
 153         return ctrl.Result{}, nil
 154 }
 155
 156 func (controller *CertificateRequestController) updateCertificateRequestWithSignedCerficates(ctx context.Context, certificateRequest *cmapi.CertificateRequest) error {
 157         return controller.setStatus(ctx, certificateRequest, cmmeta.ConditionTrue, cmapi.CertificateRequestReasonIssued, "Certificate issued")
 158 }
 159
 160 func (controller *CertificateRequestController) SetupWithManager(manager ctrl.Manager) error {
 161         return ctrl.NewControllerManagedBy(manager).
 162                 For(&cmapi.CertificateRequest{}).
 163                 Complete(controller)
 164 }
 165
 166 func (controller *CertificateRequestController) setStatus(ctx context.Context, certificateRequest *cmapi.CertificateRequest, status cmmeta.ConditionStatus, reason, message string, args ...interface{}) error {
 167         completeMessage := fmt.Sprintf(message, args...)
 168         apiutil.SetCertificateRequestCondition(certificateRequest, cmapi.CertificateRequestConditionReady, status, reason, completeMessage)
 169
 170         // Fire an Event to additionally inform users of the change
 171         eventType := core.EventTypeNormal
 172         if status == cmmeta.ConditionFalse {
 173                 eventType = core.EventTypeWarning
 174         }
 175         controller.Recorder.Event(certificateRequest, eventType, reason, completeMessage)
 176
 177         return controller.Client.Status().Update(ctx, certificateRequest)
 178 }
 179
 180 func isCMPv2IssuerReady(issuer cmpv2api.CMPv2Issuer) bool {
 181         condition := cmpv2api.CMPv2IssuerCondition{Type: cmpv2api.ConditionReady, Status: cmpv2api.ConditionTrue}
 182         return hasCondition(issuer, condition)
 183 }
 184
 185 func hasCondition(issuer cmpv2api.CMPv2Issuer, condition cmpv2api.CMPv2IssuerCondition) bool {
 186         existingConditions := issuer.Status.Conditions
 187         for _, cond := range existingConditions {
 188                 if condition.Type == cond.Type && condition.Status == cond.Status {
 189                         return true
 190                 }
 191         }
 192         return false
 193 }
 194
 195 func isCMPv2CertificateRequest(certificateRequest *cmapi.CertificateRequest) bool {
 196         return certificateRequest.Spec.IssuerRef.Group != "" &&
 197                 certificateRequest.Spec.IssuerRef.Group == cmpv2api.GroupVersion.Group &&
 198                 certificateRequest.Spec.IssuerRef.Kind == cmpv2api.CMPv2IssuerKind
 199
 200 }
 201
 202 // Error handling
 203
 204 func (controller *CertificateRequestController) handleErrorCouldNotLoadCMPv2Provisioner(ctx context.Context, log logr.Logger, issuerNamespaceName types.NamespacedName, certificateRequest *cmapi.CertificateRequest) error {
 205         err := fmt.Errorf("provisioner %s not found", issuerNamespaceName)
 206         log.Error(err, "Failed to load CMPv2 Provisioner resource")
 207         _ = controller.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to load provisioner for CMPv2Issuer resource %s", issuerNamespaceName)
 208         return err
 209 }
 210
 211 func (controller *CertificateRequestController) handleErrorCMPv2IssuerIsNotReady(ctx context.Context, log logr.Logger, issuerNamespaceName types.NamespacedName, certificateRequest *cmapi.CertificateRequest, req ctrl.Request) error {
 212         err := fmt.Errorf("resource %s is not ready", issuerNamespaceName)
 213         log.Error(err, "CMPv2Issuer not ready", "namespace", req.Namespace, "name", certificateRequest.Spec.IssuerRef.Name)
 214         _ = controller.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "CMPv2Issuer resource %s is not Ready", issuerNamespaceName)
 215         return err
 216 }
 217
 218 func (controller *CertificateRequestController) handleErrorGettingCMPv2Issuer(ctx context.Context, log logr.Logger, err error, certificateRequest *cmapi.CertificateRequest, issuerNamespaceName types.NamespacedName, req ctrl.Request) {
 219         log.Error(err, "Failed to retrieve CMPv2Issuer resource", "namespace", req.Namespace, "name", certificateRequest.Spec.IssuerRef.Name)
 220         _ = controller.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to retrieve CMPv2Issuer resource %s: %v", issuerNamespaceName, err)
 221 }
 222
 223 func (controller *CertificateRequestController) handleErrorGettingPrivateKey(ctx context.Context, log logr.Logger, err error, certificateRequest *cmapi.CertificateRequest, pkSecretNamespacedName types.NamespacedName) {
 224         log.Error(err, "Failed to retrieve private key secret for certificate request", "namespace", pkSecretNamespacedName.Namespace, "name", pkSecretNamespacedName.Name)
 225         _ = controller.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonPending, "Failed to retrieve private key secret: %v", err)
 226 }
 227
 228 func (controller *CertificateRequestController) handleErrorFailedToSignCertificate(ctx context.Context, log logr.Logger, err error, certificateRequest *cmapi.CertificateRequest) {
 229         log.Error(err, "Failed to sign certificate request")
 230         _ = controller.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonFailed, "Failed to sign certificate request: %v", err)
 231 }
 232
 233 func (controller *CertificateRequestController) handleErrorFailedToDecodeCSR(ctx context.Context, log logr.Logger, err error, certificateRequest *cmapi.CertificateRequest) {
 234         log.Error(err, "Failed to decode certificate sign request")
 235         _ = controller.setStatus(ctx, certificateRequest, cmmeta.ConditionFalse, cmapi.CertificateRequestReasonFailed, "Failed to decode CSR: %v", err)
 236 }
 237
 238
 239 func handleErrorResourceNotFound(log logr.Logger, err error) error {
 240         if apierrors.IsNotFound(err) {
 241                 log.Error(err, "CertificateRequest resource not found")
 242         } else {
 243                 log.Error(err, "Failed to retrieve CertificateRequest resource")
 244         }
 245         return err
 246 }