Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

csiaddons: add support for TLS #172

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ func main() {
var probeAddr string
var secureMetrics bool
var enableHTTP2 bool
var enableTLS bool
flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
flag.BoolVar(&enableLeaderElection, "leader-elect", false,
Expand All @@ -66,6 +67,7 @@ func main() {
"If set the metrics endpoint is served securely")
flag.BoolVar(&enableHTTP2, "enable-http2", false,
"If set, HTTP/2 will be enabled for the metrics and webhook servers")
flag.BoolVar(&enableTLS, "enable-tls", false, "If set, CertificateSigningRequests will be used to generate certificates, TLS will be used to communicate with sidecar")
opts := zap.Options{
Development: true,
}
Expand Down Expand Up @@ -122,6 +124,15 @@ func main() {
os.Exit(1)
}

if enableTLS {
if err = (&controller.CertsReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "Certificates")
}
}

if err = (&controller.DriverReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
Expand Down
2 changes: 2 additions & 0 deletions config/manager/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
resources:
- manager.yaml
- manager_role.yaml
- manager_role_binding.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
patches:
Expand Down
14 changes: 14 additions & 0 deletions config/manager/manager_role.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: manager-role
rules:
# Permissions for CSR management
- apiGroups: ["certificates.k8s.io"]
resources: ["certificatesigningrequests"]
verbs: ["create", "update", "get", "list", "approve"]

# Permissions for Secret management
- apiGroups: [""]
resources: ["secrets"]
verbs: ["create", "update", "get", "list"]
11 changes: 11 additions & 0 deletions config/manager/manager_role_binding.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: manager-role-binding
subjects:
- kind: ServiceAccount
name: controller-manageer
roleRef:
kind: Role
name: manager-role
apiGroup: rbac.authorization.k8s.io
39 changes: 39 additions & 0 deletions deploy/all-in-one/install.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14163,6 +14163,32 @@ rules:
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: ceph-csi-operator-manager-role
namespace: ceph-csi-operator-system
rules:
- apiGroups:
- certificates.k8s.io
resources:
- certificatesigningrequests
verbs:
- create
- update
- get
- list
- approve
- apiGroups:
- ""
resources:
- secrets
verbs:
- create
- update
- get
- list
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: ceph-csi-operator-rbd-ctrlplugin-r
namespace: ceph-csi-operator-system
Expand Down Expand Up @@ -15282,6 +15308,19 @@ subjects:
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: ceph-csi-operator-manager-role-binding
namespace: ceph-csi-operator-system
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: ceph-csi-operator-manager-role
subjects:
- kind: ServiceAccount
name: controller-manageer
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: ceph-csi-operator-rbd-ctrlplugin-rb
namespace: ceph-csi-operator-system
Expand Down
39 changes: 39 additions & 0 deletions deploy/multifile/operator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,32 @@ rules:
- patch
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: ceph-csi-operator-manager-role
namespace: ceph-csi-operator-system
rules:
- apiGroups:
- certificates.k8s.io
resources:
- certificatesigningrequests
verbs:
- create
- update
- get
- list
- approve
- apiGroups:
- ""
resources:
- secrets
verbs:
- create
- update
- get
- list
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
Expand Down Expand Up @@ -521,6 +547,19 @@ subjects:
namespace: ceph-csi-operator-system
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: ceph-csi-operator-manager-role-binding
namespace: ceph-csi-operator-system
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: ceph-csi-operator-manager-role
subjects:
- kind: ServiceAccount
name: controller-manageer
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
labels:
Expand Down
132 changes: 132 additions & 0 deletions internal/controller/csr_controller.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
/*
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed with the team the CSI operator should not be responsible for generation of certificates. ODF operators can generate these certificates.

Copyright 2024.

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 controller

import (
"context"
"crypto/x509"
"encoding/pem"
"errors"
"time"

certv1 "k8s.io/api/certificates/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
ctrllog "sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

//+kubebuilder:rbac:groups=csi.ceph.io,resources=drivers,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=csi.ceph.io,resources=drivers/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=csi.ceph.io,resources=drivers/finalizers,verbs=update
//+kubebuilder:rbac:groups=csi.ceph.io,resources=operatorconfigs,verbs=get;list;watch
//+kubebuilder:rbac:groups="",resources=configmaps,verbs=get;list;watch;create;update
//+kubebuilder:rbac:groups=storage.k8s.io,resources=csidrivers,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=apps,resources=deployments,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=apps,resources=daemonsets,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups="",resources=services,verbs=get;list;watch;create;update;patch;delete

type CertsReconciler struct {
client.Client
Scheme *runtime.Scheme
}

func filterCsiCertificateSigningRequests() predicate.Predicate {
return predicate.NewPredicateFuncs(func(object client.Object) bool {
labels := object.GetLabels()
return labels != nil && labels["managed-by"] == "ceph-csi-operator"
})
}

func (r *CertsReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).For(&certv1.CertificateSigningRequest{}).WithEventFilter(filterCsiCertificateSigningRequests()).Complete(r)
}

func (c *CertsReconciler) retrieveSignedCertificate(csr *certv1.CertificateSigningRequest) (ctrl.Result, error) {
if csr.Status.Certificate == nil {
// Retry later if the certificate is not ready yet
return ctrl.Result{RequeueAfter: time.Second * 5}, nil
}
return ctrl.Result{}, nil
}

func (r *CertsReconciler) Reconcile(ctx context.Context, request ctrl.Request) (reconcile.Result, error) {
log := ctrllog.FromContext(ctx)
log.Info("Starting reconcile for Certificate signing requests", "req", request)

csr := &certv1.CertificateSigningRequest{}
if err := r.Get(ctx, request.NamespacedName, csr); err != nil {
return ctrl.Result{}, client.IgnoreNotFound(err)
}

if isCSRApproved(csr) {
return r.retrieveSignedCertificate(csr)
}

// Validate CSR contents to ensure it meets the requirements
if err := validateCSR(csr); err != nil {
// Log the error, or update the status to indicate failure
return ctrl.Result{}, err
}

// Approve the CSR
csr.Status.Conditions = append(csr.Status.Conditions, certv1.CertificateSigningRequestCondition{
Type: certv1.CertificateApproved,
Status: v1.ConditionTrue,
Reason: "AutoApproved",
Message: "CSR auto-approved by Ceph CSI CSR Controller",
LastUpdateTime: metav1.Now(),
})

if err := r.Status().Update(ctx, csr); err != nil {
return ctrl.Result{}, err
}

return ctrl.Result{}, nil
}

func isCSRApproved(csr *certv1.CertificateSigningRequest) bool {
for _, condition := range csr.Status.Conditions {
if condition.Type == certv1.CertificateApproved {
return true
}
}
return false
}

// validateCSR validates CSR fields for the required certificate attributes
func validateCSR(csr *certv1.CertificateSigningRequest) error {
csrBytes, _ := pem.Decode(csr.Spec.Request)
if csrBytes == nil {
return errors.New("failed to parse CSR PEM")
}
certRequest, err := x509.ParseCertificateRequest(csrBytes.Bytes)
if err != nil {
return err
}

// Validate required fields (e.g., organization, common name, etc.)
if len(certRequest.Subject.Organization) == 0 || certRequest.Subject.CommonName == "" {
return errors.New("CSR is missing required fields")
}

return nil
}
Loading