Skip to content
Merged
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
22 changes: 22 additions & 0 deletions pkg/tlsutil/error.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// Copyright 2018 The Operator-SDK Authors
//
// 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 tlsutil

import "errors"

var (
ErrCANotFound = errors.New("ca secret and configMap are not found")
// TODO: add other tls util errors.
)
20 changes: 10 additions & 10 deletions pkg/tlsutil/tls.go
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ func (scg *SDKCertGenerator) GenerateCert(cr runtime.Object, service *v1.Service
if hasAppSecret && hasCASecretAndConfigMap {
return appSecret, caConfigMap, caSecret, nil
} else if hasAppSecret && !hasCASecretAndConfigMap {
// TODO
return nil, nil, nil, ErrCANotFound
} else if !hasAppSecret && hasCASecretAndConfigMap {
// TODO
} else {
Expand Down Expand Up @@ -196,12 +196,12 @@ func ToCASecretAndConfigMapName(kind, name string) string {

func getAppSecretInCluster(kubeClient kubernetes.Interface, name, namespace string) (*v1.Secret, error) {
se, err := kubeClient.CoreV1().Secrets(namespace).Get(name, metav1.GetOptions{})
if err != nil && !apiErrors.IsNotFound(err) {
return nil, err
}
if apiErrors.IsNotFound(err) {
return nil, nil
}
if err != nil {
return nil, err
}
return se, nil
}

Expand All @@ -210,21 +210,21 @@ func getAppSecretInCluster(kubeClient kubernetes.Interface, name, namespace stri
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{})
if err != nil && !apiErrors.IsNotFound(err) {
return nil, nil, err
}
if apiErrors.IsNotFound(err) {
hasConfigMap = false
}
if err != nil {
return nil, nil, err
}

hasSecret := true
se, err := kubeClient.CoreV1().Secrets(namespace).Get(name, metav1.GetOptions{})
if err != nil && !apiErrors.IsNotFound(err) {
return nil, nil, err
}
if apiErrors.IsNotFound(err) {
hasSecret = false
}
if err != nil {
return nil, nil, err
}

if hasConfigMap != hasSecret {
// TODO: this case can happen if creating CA configmap succeeds and creating CA secret failed. We need to handle this case properly.
Expand Down
111 changes: 76 additions & 35 deletions test/e2e/tls_util_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,35 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

var (
// TLS test variables.
crKind = "Pod"
crName = "example-pod"
certName = "app-cert"

caConfigMapAndSecretName = tlsutil.ToCASecretAndConfigMapName(crKind, crName)
caConfigMap = &v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: caConfigMapAndSecretName,
},
}
caSecret = &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: caConfigMapAndSecretName,
},
}

appSecret = &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: tlsutil.ToAppSecretName(crKind, crName, certName),
},
}

ccfg = &tlsutil.CertConfig{
CertName: certName,
}
)

// TestBothAppAndCATLSAssetsExist ensures that when both application
// and CA TLS assets exist in the k8s cluster for a given cr,
// the GenerateCert() simply returns those to the caller.
Expand All @@ -37,9 +66,23 @@ func TestBothAppAndCATLSAssetsExist(t *testing.T) {
t.Fatal(err)
}

appSecret, err := f.KubeClient.CoreV1().Secrets(namespace).Create(appSecret)
if err != nil {
t.Fatal(err)
}

caConfigMap, err := f.KubeClient.CoreV1().ConfigMaps(namespace).Create(caConfigMap)
if err != nil {
t.Fatal(err)
}

caSecret, err := f.KubeClient.CoreV1().Secrets(namespace).Create(caSecret)
if err != nil {
t.Fatal(err)
}

cg := tlsutil.NewSDKCertGenerator(f.KubeClient)
// Use Pod as a dummy runtime object for the CR input of GenerateCert().
crKind := "Pod"
crName := "example-pod"
mCR := &v1.Pod{
TypeMeta: metav1.TypeMeta{
Kind: crKind,
Expand All @@ -49,55 +92,53 @@ func TestBothAppAndCATLSAssetsExist(t *testing.T) {
Namespace: namespace,
},
}

certName := "app-cert"
appSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: tlsutil.ToAppSecretName(crKind, crName, certName),
},
}
appSecret, err = f.KubeClient.CoreV1().Secrets(namespace).Create(appSecret)
actualAppSecret, actualCaConfigMap, actualCaSecret, err := cg.GenerateCert(mCR, nil, ccfg)
if err != nil {
t.Fatal(err)
}

caConfigMapAndSecretName := tlsutil.ToCASecretAndConfigMapName(crKind, crName)
caConfigMap := &v1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{
Name: caConfigMapAndSecretName,
},
if !reflect.DeepEqual(appSecret, actualAppSecret) {
t.Fatalf("expect %+v, but got %+v", appSecret, actualAppSecret)
}
caConfigMap, err = f.KubeClient.CoreV1().ConfigMaps(namespace).Create(caConfigMap)
if err != nil {
t.Fatal(err)
if !reflect.DeepEqual(caConfigMap, actualCaConfigMap) {
t.Fatalf("expect %+v, but got %+v", caConfigMap, actualCaConfigMap)
}

caSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: caConfigMapAndSecretName,
},
if !reflect.DeepEqual(caSecret, actualCaSecret) {
t.Fatalf("expect %+v, but got %+v", caSecret, actualCaSecret)
}
caSecret, err = f.KubeClient.CoreV1().Secrets(namespace).Create(caSecret)
}

// 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)
defer ctx.Cleanup(t)
namespace, err := ctx.GetNamespace()
if err != nil {
t.Fatal(err)
}

cg := tlsutil.NewSDKCertGenerator(f.KubeClient)
ccfg := &tlsutil.CertConfig{
CertName: certName,
}
actualAppSecret, actualCaConfigMap, actualCaSecret, err := cg.GenerateCert(mCR, nil, ccfg)
_, err = f.KubeClient.CoreV1().Secrets(namespace).Create(appSecret)
if err != nil {
t.Fatal(err)
}

if !reflect.DeepEqual(appSecret, actualAppSecret) {
t.Fatalf("expect %+v, got %+v", appSecret, actualAppSecret)
cg := tlsutil.NewSDKCertGenerator(f.KubeClient)
// Use Pod as a dummy runtime object for the CR input of GenerateCert().
mCR := &v1.Pod{
TypeMeta: metav1.TypeMeta{
Kind: crKind,
},
ObjectMeta: metav1.ObjectMeta{
Name: crName,
Namespace: namespace,
},
}
if !reflect.DeepEqual(caConfigMap, actualCaConfigMap) {
t.Fatalf("expect %+v, got %+v", caConfigMap, actualCaConfigMap)
_, _, _, err = cg.GenerateCert(mCR, nil, ccfg)
if err == nil {
t.Fatal("expect error, but got none")
}
if !reflect.DeepEqual(caSecret, actualCaSecret) {
t.Fatalf("expect %+v, got %+v", caSecret, actualCaSecret)
if err != tlsutil.ErrCANotFound {
t.Fatalf("expect %v, but got %v", tlsutil.ErrCANotFound.Error(), err.Error())
}
}