-
Notifications
You must be signed in to change notification settings - Fork 2k
/
tests.go
368 lines (331 loc) · 14 KB
/
tests.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
/*
Copyright 2021 The cert-manager 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 certificatesigningrequests
import (
"context"
"crypto/x509"
"net"
"net/url"
"time"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
certificatesv1 "k8s.io/api/certificates/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
experimentalapi "github.com/jetstack/cert-manager/pkg/apis/experimental/v1alpha1"
"github.com/jetstack/cert-manager/pkg/util"
"github.com/jetstack/cert-manager/test/e2e/framework"
"github.com/jetstack/cert-manager/test/e2e/framework/helper/featureset"
"github.com/jetstack/cert-manager/test/e2e/framework/helper/validation"
"github.com/jetstack/cert-manager/test/e2e/framework/helper/validation/certificatesigningrequests"
e2eutil "github.com/jetstack/cert-manager/test/e2e/util"
"github.com/jetstack/cert-manager/test/unit/gen"
)
// Defines simple conformance tests that can be run against any issuer type.
// If Complete has not been called on this Suite before Define, it will be
// automatically called.
// The tests in this file require that the CertificateSigningRequest
// controllers are active
// (--feature-gates=ExperimentalCertificateSigningRequestControllers=true). If
// they are not active, these tests will fail.
func (s *Suite) Define() {
Describe("CertificateSigningRequest with issuer type "+s.Name, func() {
ctx := context.Background()
f := framework.NewDefaultFramework("certificatesigningrequests")
// wrap this in a BeforeEach else flags will not have been parsed at
// the time that the `complete` function is called.
BeforeEach(func() {
if !s.completed {
s.complete(f)
}
})
sharedURI, err := url.Parse("spiffe://cluster.local/ns/sandbox/sa/foo")
if err != nil {
// This should never happen, and is a bug. Panic to prevent garbage test
// data.
panic(err)
}
sharedCommonName := e2eutil.RandomSubdomain(s.DomainSuffix)
type testCase struct {
keyAlgo x509.PublicKeyAlgorithm
csrModifiers []gen.CSRModifier
kubeCSRUsages []certificatesv1.KeyUsage
kubeCSRAnnotations map[string]string
// The list of features that are required by the Issuer for the test to
// run.
requiredFeatures []featureset.Feature
// Extra validations which may be needed for testing, on a test case by
// case basis. All default validations will be run on every test.
extraValidations []certificatesigningrequests.ValidationFunc
}
tests := map[string]testCase{
"should issue an RSA certificate for a single distinct DNS Name": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{gen.SetCSRDNSNames(e2eutil.RandomSubdomain(s.DomainSuffix))},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.OnlySAN},
},
"should issue an ECDSA certificate for a single distinct DNS Name": {
keyAlgo: x509.ECDSA,
csrModifiers: []gen.CSRModifier{gen.SetCSRDNSNames(e2eutil.RandomSubdomain(s.DomainSuffix))},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.ECDSAFeature, featureset.OnlySAN},
},
"should issue an Ed25519 certificate for a single distinct DNS Name": {
keyAlgo: x509.Ed25519,
csrModifiers: []gen.CSRModifier{gen.SetCSRDNSNames(e2eutil.RandomSubdomain(s.DomainSuffix))},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.Ed25519FeatureSet, featureset.OnlySAN},
},
"should issue an RSA certificate for a single Common Name": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{gen.SetCSRCommonName("test-common-name-" + util.RandStringRunes(10))},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{},
},
"should issue an ECDSA certificate for a single Common Name": {
keyAlgo: x509.ECDSA,
csrModifiers: []gen.CSRModifier{gen.SetCSRCommonName("test-common-name-" + util.RandStringRunes(10))},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.CommonNameFeature, featureset.ECDSAFeature},
},
"should issue an Ed25519 certificate for a single Common Name": {
keyAlgo: x509.Ed25519,
csrModifiers: []gen.CSRModifier{gen.SetCSRCommonName("test-common-name-" + util.RandStringRunes(10))},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.CommonNameFeature, featureset.Ed25519FeatureSet},
},
"should issue a certificate that defines a Common Name and IP Address": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRCommonName("test-common-name-" + util.RandStringRunes(10)),
gen.SetCSRIPAddresses(net.IPv4(127, 0, 0, 1), net.IPv4(8, 8, 8, 8)),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.CommonNameFeature, featureset.IPAddressFeature},
},
"should issue a certificate that defines an Email Address": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSREmails([]string{"alice@example.com", "bob@cert-manager.io"}),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.OnlySAN, featureset.EmailSANsFeature},
},
"should issue a certificate that defines a CommonName and URI SAN": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRCommonName("test-common-name-" + util.RandStringRunes(10)),
gen.SetCSRURIs(sharedURI),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.CommonNameFeature, featureset.URISANsFeature},
},
"should issue a certificate that defines a 2 distinct DNS Name with one copied to the Common Name": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRCommonName(sharedCommonName),
gen.SetCSRDNSNames(sharedCommonName, e2eutil.RandomSubdomain(s.DomainSuffix)),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{},
},
"should issue a certificate that defines a distinct DNS Name and another distinct Common Name": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRCommonName(e2eutil.RandomSubdomain(s.DomainSuffix)),
gen.SetCSRDNSNames(e2eutil.RandomSubdomain(s.DomainSuffix)),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.CommonNameFeature},
},
"should issue a certificate that defines a CommonName, DNS Name, and sets a duration": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRDNSNames(sharedCommonName),
gen.SetCSRDNSNames(sharedCommonName),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
kubeCSRAnnotations: map[string]string{
experimentalapi.CertificateSigningRequestDurationAnnotationKey: "896h",
},
requiredFeatures: []featureset.Feature{featureset.DurationFeature},
},
"should issue a certificate that defines a DNS Name and sets a duration": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRDNSNames(e2eutil.RandomSubdomain(s.DomainSuffix)),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
kubeCSRAnnotations: map[string]string{
experimentalapi.CertificateSigningRequestDurationAnnotationKey: "896h",
},
requiredFeatures: []featureset.Feature{featureset.OnlySAN, featureset.DurationFeature},
},
"should issue a certificate which has a wildcard DNS name defined": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRDNSNames("*." + e2eutil.RandomSubdomain(s.DomainSuffix)),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.WildcardsFeature, featureset.OnlySAN},
},
"should issue a certificate that includes only a URISANs name": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRURIs(sharedURI),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.URISANsFeature, featureset.OnlySAN},
},
"should issue a certificate that includes arbitrary key usages": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRCommonName(sharedCommonName),
gen.SetCSRDNSNames(sharedCommonName),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageServerAuth,
certificatesv1.UsageClientAuth,
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageDataEncipherment,
},
requiredFeatures: []featureset.Feature{featureset.KeyUsagesFeature},
extraValidations: []certificatesigningrequests.ValidationFunc{
certificatesigningrequests.ExpectKeyUsageExtKeyUsageClientAuth,
certificatesigningrequests.ExpectKeyUsageExtKeyUsageServerAuth,
certificatesigningrequests.ExpectKeyUsageUsageDigitalSignature,
certificatesigningrequests.ExpectKeyUsageUsageDataEncipherment,
},
},
"should issue a signing CA certificate that has a large duration": {
keyAlgo: x509.RSA,
csrModifiers: []gen.CSRModifier{
gen.SetCSRCommonName("cert-manager-ca"),
},
kubeCSRUsages: []certificatesv1.KeyUsage{
certificatesv1.UsageDigitalSignature,
certificatesv1.UsageKeyEncipherment,
certificatesv1.UsageCertSign,
},
kubeCSRAnnotations: map[string]string{
experimentalapi.CertificateSigningRequestDurationAnnotationKey: "10000h",
experimentalapi.CertificateSigningRequestIsCAAnnotationKey: "true",
},
requiredFeatures: []featureset.Feature{featureset.KeyUsagesFeature, featureset.DurationFeature, featureset.CommonNameFeature},
},
}
defineTest := func(name string, test testCase) {
s.it(f, name, func(signerName string) {
// Generate request CSR
csr, key, err := gen.CSR(test.keyAlgo, test.csrModifiers...)
Expect(err).NotTo(HaveOccurred())
// Create CertificateSigningRequest
kubeCSR := &certificatesv1.CertificateSigningRequest{
ObjectMeta: metav1.ObjectMeta{
GenerateName: "e2e-conformance-",
Annotations: test.kubeCSRAnnotations,
},
Spec: certificatesv1.CertificateSigningRequestSpec{
Request: csr,
SignerName: signerName,
Usages: test.kubeCSRUsages,
},
}
// Provision any resources needed for the request, or modify the
// request based on Issuer requirements
if s.ProvisionFunc != nil {
s.ProvisionFunc(f, kubeCSR, key)
}
// Ensure related resources are cleaned up at the end of the test
if s.DeProvisionFunc != nil {
defer s.DeProvisionFunc(f, kubeCSR)
}
// Create the request, and delete at the end of the test
By("Creating a CertificateSigningRequest")
Expect(f.CRClient.Create(ctx, kubeCSR)).NotTo(HaveOccurred())
defer f.CRClient.Delete(context.TODO(), kubeCSR)
// Approve the request for testing, so that cert-manager may sign the
// request.
By("Approving CertificateSigningRequest")
kubeCSR.Status.Conditions = append(kubeCSR.Status.Conditions, certificatesv1.CertificateSigningRequestCondition{
Type: certificatesv1.CertificateApproved,
Status: corev1.ConditionTrue,
Reason: "e2e.cert-manager.io",
Message: "Request approved for e2e testing.",
})
kubeCSR, err = f.KubeClientSet.CertificatesV1().CertificateSigningRequests().UpdateApproval(context.TODO(), kubeCSR.Name, kubeCSR, metav1.UpdateOptions{})
Expect(err).NotTo(HaveOccurred())
// Wait for the status.Certificate and CA annotation to be populated in
// a reasonable amount of time.
By("Waiting for the CertificateSigningRequest to be issued...")
kubeCSR, err = f.Helper().WaitForCertificateSigningRequestSigned(kubeCSR.Name, time.Minute*5)
Expect(err).NotTo(HaveOccurred())
// Validate that the request was signed as expected. Add extra
// validations which may be required for this test.
By("Validating the issued CertificateSigningRequest...")
validations := append(test.extraValidations, validation.CertificateSigningRequestSetForUnsupportedFeatureSet(s.UnsupportedFeatures)...)
err = f.Helper().ValidateCertificateSigningRequest(kubeCSR.Name, key, validations...)
Expect(err).NotTo(HaveOccurred())
}, test.requiredFeatures...)
}
for name := range tests {
defineTest(name, tests[name])
}
})
}