|
| 1 | +/* |
| 2 | +Copyright 2024 The Kubernetes Authors. |
| 3 | +
|
| 4 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | +you may not use this file except in compliance with the License. |
| 6 | +You may obtain a copy of the License at |
| 7 | +
|
| 8 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | +
|
| 10 | +Unless required by applicable law or agreed to in writing, software |
| 11 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | +See the License for the specific language governing permissions and |
| 14 | +limitations under the License. |
| 15 | +*/ |
| 16 | + |
| 17 | +package validation |
| 18 | + |
| 19 | +import ( |
| 20 | + "testing" |
| 21 | + |
| 22 | + "github.com/google/go-cmp/cmp" |
| 23 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 24 | + apimachinerytypes "k8s.io/apimachinery/pkg/types" |
| 25 | + "k8s.io/apimachinery/pkg/util/validation/field" |
| 26 | + "k8s.io/kubernetes/pkg/apis/core" |
| 27 | +) |
| 28 | + |
| 29 | +func TestOpenShiftValidateSecretUpdate(t *testing.T) { |
| 30 | + newSecretFn := func(ns, name string, secretType core.SecretType) *core.Secret { |
| 31 | + return &core.Secret{ |
| 32 | + ObjectMeta: metav1.ObjectMeta{ |
| 33 | + Name: name, |
| 34 | + Namespace: ns, |
| 35 | + ResourceVersion: "1", |
| 36 | + }, |
| 37 | + Type: secretType, |
| 38 | + Data: map[string][]byte{ |
| 39 | + "tls.key": []byte("foo"), |
| 40 | + "tls.crt": []byte("bar"), |
| 41 | + }, |
| 42 | + } |
| 43 | + } |
| 44 | + invalidTypeErrFn := func(secretType core.SecretType) field.ErrorList { |
| 45 | + return field.ErrorList{ |
| 46 | + field.Invalid(field.NewPath("type"), secretType, "field is immutable"), |
| 47 | + } |
| 48 | + } |
| 49 | + tlsKeyRequiredErrFn := func() field.ErrorList { |
| 50 | + return field.ErrorList{ |
| 51 | + field.Required(field.NewPath("data").Key(core.TLSCertKey), ""), |
| 52 | + field.Required(field.NewPath("data").Key(core.TLSPrivateKeyKey), ""), |
| 53 | + } |
| 54 | + } |
| 55 | + |
| 56 | + t.Run("verify whitelist", func(t *testing.T) { |
| 57 | + for key := range whitelist { |
| 58 | + ns, name := key.Namespace, key.Name |
| 59 | + |
| 60 | + // exercise a valid type mutation: "SecretTypeTLS" -> "kubernetes.io/tls" |
| 61 | + oldSecret, newSecret := newSecretFn(ns, name, "SecretTypeTLS"), newSecretFn(ns, name, core.SecretTypeTLS) |
| 62 | + if errs := ValidateSecretUpdate(newSecret, oldSecret); len(errs) > 0 { |
| 63 | + t.Errorf("unexpected error: %v", errs) |
| 64 | + } |
| 65 | + |
| 66 | + // the reverse should not be allowed |
| 67 | + errExpected := invalidTypeErrFn("SecretTypeTLS") |
| 68 | + oldSecret, newSecret = newSecretFn(ns, name, core.SecretTypeTLS), newSecretFn(ns, name, "SecretTypeTLS") |
| 69 | + if errGot := ValidateSecretUpdate(newSecret, oldSecret); !cmp.Equal(errExpected, errGot) { |
| 70 | + t.Errorf("expected error: %v, diff: %s", errExpected, cmp.Diff(errExpected, errGot)) |
| 71 | + } |
| 72 | + |
| 73 | + // no type change, no validation failure expected |
| 74 | + oldSecret, newSecret = newSecretFn(ns, name, core.SecretTypeTLS), newSecretFn(ns, name, core.SecretTypeTLS) |
| 75 | + if errs := ValidateSecretUpdate(newSecret, oldSecret); len(errs) > 0 { |
| 76 | + t.Errorf("unexpected error: %v", errs) |
| 77 | + } |
| 78 | + |
| 79 | + // exercise an invalid type mutation, we expect validation failure |
| 80 | + errExpected = invalidTypeErrFn(core.SecretTypeOpaque) |
| 81 | + oldSecret, newSecret = newSecretFn(ns, name, "SecretTypeTLS"), newSecretFn(ns, name, core.SecretTypeOpaque) |
| 82 | + if errGot := ValidateSecretUpdate(newSecret, oldSecret); !cmp.Equal(errExpected, errGot) { |
| 83 | + t.Errorf("expected error: %v, diff: %s", errExpected, cmp.Diff(errExpected, errGot)) |
| 84 | + } |
| 85 | + |
| 86 | + // verify that kbernetes.io/tls validation ar enforced |
| 87 | + errExpected = tlsKeyRequiredErrFn() |
| 88 | + oldSecret, newSecret = newSecretFn(ns, name, "SecretTypeTLS"), newSecretFn(ns, name, core.SecretTypeTLS) |
| 89 | + newSecret.Data = nil |
| 90 | + if errGot := ValidateSecretUpdate(newSecret, oldSecret); !cmp.Equal(errExpected, errGot) { |
| 91 | + t.Errorf("expected error: %v, diff: %s", errExpected, cmp.Diff(errExpected, errGot)) |
| 92 | + } |
| 93 | + } |
| 94 | + }) |
| 95 | + |
| 96 | + // we must not break secrets that are not in the whitelist |
| 97 | + tests := []struct { |
| 98 | + name string |
| 99 | + oldSecret *core.Secret |
| 100 | + newSecret *core.Secret |
| 101 | + errExpected field.ErrorList |
| 102 | + }{ |
| 103 | + { |
| 104 | + name: "secret is not whitelisted, valid type transition, update not allowed", |
| 105 | + oldSecret: newSecretFn("foo", "bar", "SecretTypeTLS"), |
| 106 | + newSecret: newSecretFn("foo", "bar", core.SecretTypeTLS), |
| 107 | + errExpected: invalidTypeErrFn(core.SecretTypeTLS), |
| 108 | + }, |
| 109 | + { |
| 110 | + name: "secret is not whitelisted, invalid type transition, update not allowed", |
| 111 | + oldSecret: newSecretFn("foo", "bar", "SecretTypeTLS"), |
| 112 | + newSecret: newSecretFn("foo", "bar", core.SecretTypeOpaque), |
| 113 | + errExpected: invalidTypeErrFn(core.SecretTypeOpaque), |
| 114 | + }, |
| 115 | + { |
| 116 | + name: "secret is not whitelisted, no type transition, update allowed", |
| 117 | + oldSecret: newSecretFn("foo", "bar", core.SecretTypeTLS), |
| 118 | + newSecret: newSecretFn("foo", "bar", core.SecretTypeTLS), |
| 119 | + }, |
| 120 | + } |
| 121 | + |
| 122 | + for _, test := range tests { |
| 123 | + t.Run(test.name, func(t *testing.T) { |
| 124 | + key := apimachinerytypes.NamespacedName{Namespace: test.oldSecret.Namespace, Name: test.oldSecret.Name} |
| 125 | + if _, ok := whitelist[key]; ok { |
| 126 | + t.Errorf("misconfigured test: secret is in whitelist: %s", key) |
| 127 | + return |
| 128 | + } |
| 129 | + |
| 130 | + errGot := ValidateSecretUpdate(test.newSecret, test.oldSecret) |
| 131 | + if !cmp.Equal(test.errExpected, errGot) { |
| 132 | + t.Errorf("expected error: %v, diff: %s", test.errExpected, cmp.Diff(test.errExpected, errGot)) |
| 133 | + } |
| 134 | + }) |
| 135 | + } |
| 136 | +} |
0 commit comments