pkg/tlsutil: add support for custom CA

Author: rithujohn191

pkg/tlsutil/error.go

@@ -17,6 +17,11 @@ package tlsutil
 import "errors"
 
 var (
-	ErrCANotFound = errors.New("ca secret and configMap are not found")
+	ErrCANotFound        = errors.New("ca secret and configMap are not found")
+	ErrCAKeyAndCACertReq = errors.New("CA key and CA cert need to be provided when requesting a custom CA.")
+	ErrReadingCAKey      = errors.New("error reading CA Key from the given file name.")
+	ErrReadingCACert     = errors.New("error reading CA Cert from the given file name.")
+	ErrParsingCAKey      = errors.New("error parsing CA Cert from the given file name.")
+	ErrParsingCACert     = errors.New("error parsing CA Cert from the given file name.")
 	// TODO: add other tls util errors.
 )

pkg/tlsutil/tls.go

@@ -19,6 +19,7 @@ import (
 	"crypto/x509"
 	"errors"
 	"fmt"
+	"io/ioutil"
 	"strings"
 
 	"k8s.io/api/core/v1"
@@ -138,6 +139,9 @@ type SDKCertGenerator struct {
 	KubeClient kubernetes.Interface
 }
 
+// GenerateCert returns a secret containing the TLS encryption key and cert,
+// a ConfigMap containing the CA Certificate and a Secret containing the CA key or it
+// returns a error incase something goes wrong.
 func (scg *SDKCertGenerator) GenerateCert(cr runtime.Object, service *v1.Service, config *CertConfig) (*v1.Secret, *v1.ConfigMap, *v1.Secret, error) {
 	if err := verifyConfig(config); err != nil {
 		return nil, nil, nil, err
@@ -161,11 +165,15 @@ func (scg *SDKCertGenerator) GenerateCert(cr runtime.Object, service *v1.Service
 	hasAppSecret := appSecret != nil
 	hasCASecretAndConfigMap := caSecret != nil && caConfigMap != nil
 	// TODO: handle passed in CA
+
 	if hasAppSecret && hasCASecretAndConfigMap {
 		return appSecret, caConfigMap, caSecret, nil
-	} else if hasAppSecret && !hasCASecretAndConfigMap {
+	}
+	if hasAppSecret && !hasCASecretAndConfigMap {
 		return nil, nil, nil, ErrCANotFound
-	} else if !hasAppSecret && hasCASecretAndConfigMap {
+	}
+
+	if !hasAppSecret && hasCASecretAndConfigMap {
 		caKey, err := parsePEMEncodedPrivateKey(caSecret.Data[TLSPrivateCAKeyKey])
 		if err != nil {
 			return nil, nil, nil, err
@@ -188,16 +196,54 @@ func (scg *SDKCertGenerator) GenerateCert(cr runtime.Object, service *v1.Service
 		}
 		return appSecret, caConfigMap, caSecret, nil
 	} else {
+		var caKeyData, caCertData []byte
+		var err error
+		var caKey *rsa.PrivateKey
+		var caCert *x509.Certificate
 		// case: both CA and Application TLS assets don't exist.
-		caKey, err := newPrivateKey()
-		if err != nil {
-			return nil, nil, nil, err
+		if config.CAKey != "" && config.CACert != "" {
+			// custom CA provided by the user.
+			caKeyData, err = ioutil.ReadFile(config.CAKey)
+			if err != nil {
+				return nil, nil, nil, ErrReadingCAKey
+			}
+
+			caCertData, err = ioutil.ReadFile(config.CACert)
+			if err != nil {
+				return nil, nil, nil, ErrReadingCACert
+			}
+
+			caKey, err = parsePEMEncodedPrivateKey(caKeyData)
+			if err != nil {
+				return nil, nil, nil, ErrParsingCAKey
+			}
+
+			caCert, err = parsePEMEncodedCert(caCertData)
+			if err != nil {
+				return nil, nil, nil, ErrParsingCACert
+			}
+
 		}
-		caCert, err := newSelfSignedCACertificate(caKey)
-		if err != nil {
-			return nil, nil, nil, err
+
+		if config.CAKey != "" || config.CACert != "" {
+			// if only one of the custom CA Key or Cert is provided
+			return nil, nil, nil, ErrCAKeyAndCACertReq
+		} else {
+			// If no custom CAKey and CACert are provided we have to generate them
+			caKey, err := newPrivateKey()
+			if err != nil {
+				return nil, nil, nil, err
+			}
+			caCert, err := newSelfSignedCACertificate(caKey)
+			if err != nil {
+				return nil, nil, nil, err
+			}
+
+			caKeyData = encodePrivateKeyPEM(caKey)
+			caCertData = encodeCertificatePEM(caCert)
 		}
-		caSecret, caConfigMap := toCASecretAndConfigmap(caKey, caCert, caSecretAndConfigMapName)
+
+		caSecret, caConfigMap := toCASecretAndConfigmap(caKeyData, caCertData, caSecretAndConfigMapName)
 		caSecret, err = scg.KubeClient.CoreV1().Secrets(ns).Create(caSecret)
 		if err != nil {
 			return nil, nil, nil, err
@@ -252,7 +298,11 @@ func getAppSecretInCluster(kubeClient kubernetes.Interface, name, namespace stri
 }
 
 // getCASecretAndConfigMapInCluster gets CA secret and configmap of the given name and namespace.
-// it only returns both if they are found and nil if both are not found. In the case if only one of them is found, then we error out because we expect either both CA secret and configmap exit or not.
+// it only returns both if they are found and nil if both are not found. In the case if only one of them is found,
+// then we error out because we expect either both CA secret and configmap exit or not.
+//
+// NOTE: both the CA secret and configmap have the same name with template `<cr-kind>-<cr-name>-ca` which is what the
+// input parameter `name` refers to.
 func getCASecretAndConfigMapInCluster(kubeClient kubernetes.Interface, name, namespace string) (*v1.Secret, *v1.ConfigMap, error) {
 	hasConfigMap := true
 	cm, err := kubeClient.CoreV1().ConfigMaps(namespace).Get(name, metav1.GetOptions{})
@@ -315,20 +365,20 @@ func toTLSSecret(key *rsa.PrivateKey, cert *x509.Certificate, name string) *v1.S
 }
 
 // TODO: add owner ref.
-func toCASecretAndConfigmap(key *rsa.PrivateKey, cert *x509.Certificate, name string) (*v1.Secret, *v1.ConfigMap) {
+func toCASecretAndConfigmap(key, cert []byte, name string) (*v1.Secret, *v1.ConfigMap) {
 	return &v1.Secret{
 			ObjectMeta: metav1.ObjectMeta{
 				Name: name,
 			},
 			Data: map[string][]byte{
-				TLSPrivateCAKeyKey: encodePrivateKeyPEM(key),
+				TLSPrivateCAKeyKey: key,
 			},
 		}, &v1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
 				Name: name,
 			},
 			Data: map[string]string{
-				TLSCACertKey: string(encodeCertificatePEM(cert)),
+				TLSCACertKey: string(cert),
 			},
 		}
 }

test/e2e/tls_util_test.go

@@ -121,7 +121,10 @@ func TestBothAppAndCATLSAssetsExist(t *testing.T) {
 	}
 }
 
-// TestOnlyAppSecretExist tests a case where the application TLS asset exists but its correspoding CA asset doesn't. In this case, CertGenerator can't genereate a new CA because it won't verify the existing application TLS cert. Therefore, CertGenerator can't proceed and returns an error to the caller.
+// TestOnlyAppSecretExist tests a case where the application TLS asset exists but its
+// correspoding CA asset doesn't. In this case, CertGenerator can't genereate a new CA because
+// it won't verify the existing application TLS cert. Therefore, CertGenerator can't proceed
+// and returns an error to the caller.
 func TestOnlyAppSecretExist(t *testing.T) {
 	f := framework.Global
 	ctx := f.NewTestCtx(t)
@@ -146,7 +149,7 @@ func TestOnlyAppSecretExist(t *testing.T) {
 	}
 }
 
-// TestOnlyCAExist ensures that at the case where only the CA exists in the cluster;
+// TestOnlyCAExist tests the case where only the CA exists in the cluster;
 // GenerateCert can retrieve the CA and uses it to create a new application secret.
 func TestOnlyCAExist(t *testing.T) {
 	f := framework.Global
@@ -197,6 +200,31 @@ func TestNoneOfCaAndAppSecretExist(t *testing.T) {
 	verifyCASecret(t, caSecret, namespace)
 }
 
+// TestCustomCA ensures that if a user provides a custom Key and Cert and the CA and Application TLS assets
+// do not exist, the GenerateCert method can use the custom CA to generate the TLS assest.
+func TestCustomCA(t *testing.T) {
+	f := framework.Global
+	ctx := f.NewTestCtx(t)
+	defer ctx.Cleanup(t)
+	namespace, err := ctx.GetNamespace()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	cg := tlsutil.NewSDKCertGenerator(f.KubeClient)
+
+	ccfg.CAKey = "./testdata/ca.key"
+	ccfg.CACert = "./testdata/ca.crt"
+	appSecret, caConfigMap, caSecret, err := cg.GenerateCert(newDummyCR(namespace), newAppSvc(namespace), ccfg)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	verifyAppSecret(t, appSecret, namespace)
+	verifyCaConfigMap(t, caConfigMap, namespace)
+	verifyCASecret(t, caSecret, namespace)
+}
+
 func verifyCASecret(t *testing.T, caSecret *v1.Secret, namespace string) {
 	// check if caConfigMap has the correct fields.
 	if caConfigMapAndSecretName != caSecret.Name {