Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3306 from jetstack-bot/cherry-pick-3279-to-releas…
…e-1.0 [release-1.0] Fix double "signing" KU validation
- Loading branch information
Showing
4 changed files
with
198 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
158 changes: 158 additions & 0 deletions
158
pkg/internal/apis/certmanager/validation/certificaterequest_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /* | ||
| Copyright 2020 The Jetstack cert-manager contributors. | ||
| 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 validation | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/pem" | ||
| "reflect" | ||
| "testing" | ||
|
|
||
| "k8s.io/apimachinery/pkg/util/validation/field" | ||
|
|
||
| cmapi "github.com/jetstack/cert-manager/pkg/apis/certmanager/v1" | ||
| cminternal "github.com/jetstack/cert-manager/pkg/internal/apis/certmanager" | ||
| "github.com/jetstack/cert-manager/pkg/util/pki" | ||
| utilpki "github.com/jetstack/cert-manager/pkg/util/pki" | ||
| "github.com/jetstack/cert-manager/test/unit/gen" | ||
| ) | ||
|
|
||
| func TestValidateCertificateRequestSpec(t *testing.T) { | ||
| fldPath := field.NewPath("test") | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| crSpec *cminternal.CertificateRequestSpec | ||
| want field.ErrorList | ||
| }{ | ||
| { | ||
| name: "Test csr with no usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"))), | ||
| IssuerRef: validIssuerRef, | ||
| Usages: nil, | ||
| }, | ||
| want: []*field.Error{}, | ||
| }, | ||
| { | ||
| name: "Test csr with double signature usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageSigning, cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment))), | ||
| IssuerRef: validIssuerRef, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageSigning, cminternal.UsageKeyEncipherment}, | ||
| }, | ||
| want: []*field.Error{}, | ||
| }, | ||
| { | ||
| name: "Test csr with double extended usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment, cmapi.UsageServerAuth, cmapi.UsageClientAuth))), | ||
| IssuerRef: validIssuerRef, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageSigning, cminternal.UsageKeyEncipherment, cminternal.UsageServerAuth, cminternal.UsageClientAuth}, | ||
| }, | ||
| want: []*field.Error{}, | ||
| }, | ||
| { | ||
| name: "Test csr with reordered usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment, cmapi.UsageServerAuth, cmapi.UsageClientAuth))), | ||
| IssuerRef: validIssuerRef, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageServerAuth, cminternal.UsageClientAuth, cminternal.UsageKeyEncipherment, cminternal.UsageDigitalSignature}, | ||
| }, | ||
| want: []*field.Error{}, | ||
| }, | ||
| { | ||
| name: "Test csr that is CA with usages set", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageAny, cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment, cmapi.UsageCertSign), gen.SetCertificateIsCA(true))), | ||
| IssuerRef: validIssuerRef, | ||
| IsCA: true, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageAny, cminternal.UsageDigitalSignature, cminternal.UsageKeyEncipherment, cminternal.UsageCertSign}, | ||
| }, | ||
| want: []*field.Error{}, | ||
| }, | ||
| { | ||
| name: "Test csr that is CA but no cert sign in usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageAny, cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment, cmapi.UsageClientAuth, cmapi.UsageServerAuth), gen.SetCertificateIsCA(true))), | ||
| IssuerRef: validIssuerRef, | ||
| IsCA: true, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageAny, cminternal.UsageDigitalSignature, cminternal.UsageKeyEncipherment, cminternal.UsageClientAuth, cminternal.UsageServerAuth}, | ||
| }, | ||
| want: []*field.Error{}, | ||
| }, | ||
| { | ||
| name: "Error on csr not having all usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment, cmapi.UsageServerAuth))), | ||
| IssuerRef: validIssuerRef, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageSigning, cminternal.UsageKeyEncipherment, cminternal.UsageServerAuth, cminternal.UsageClientAuth}, | ||
| }, | ||
| want: []*field.Error{ | ||
| field.Invalid(fldPath.Child("request"), nil, "csr key usages do not match specified usages, these should match if both are set: [[]certmanager.KeyUsage[3] != []certmanager.KeyUsage[4]]"), | ||
| }, | ||
| }, | ||
| { | ||
| name: "Error on cr not having all usages", | ||
| crSpec: &cminternal.CertificateRequestSpec{ | ||
| Request: mustGenerateCSR(t, gen.Certificate("test", gen.SetCertificateDNSNames("example.com"), gen.SetCertificateKeyUsages(cmapi.UsageDigitalSignature, cmapi.UsageKeyEncipherment, cmapi.UsageServerAuth, cmapi.UsageClientAuth))), | ||
| IssuerRef: validIssuerRef, | ||
| Usages: []cminternal.KeyUsage{cminternal.UsageSigning, cminternal.UsageKeyEncipherment}, | ||
| }, | ||
| want: []*field.Error{ | ||
| field.Invalid(fldPath.Child("request"), nil, "csr key usages do not match specified usages, these should match if both are set: [[]certmanager.KeyUsage[4] != []certmanager.KeyUsage[2]]"), | ||
| }, | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| got := ValidateCertificateRequestSpec(tt.crSpec, field.NewPath("test"), true) | ||
| for i := range got { | ||
| // filter out the value so it does not print the full CSR in tests | ||
| got[i].BadValue = nil | ||
| } | ||
| if !reflect.DeepEqual(got, tt.want) { | ||
| t.Errorf("ValidateCertificateRequestSpec() = %v, want %v", got, tt.want) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func mustGenerateCSR(t *testing.T, crt *cmapi.Certificate) []byte { | ||
| // Create a new private key | ||
| pk, err := utilpki.GenerateRSAPrivateKey(2048) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| x509CSR, err := pki.GenerateCSR(crt) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| csrDER, err := pki.EncodeCSR(x509CSR, pk) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| csrPEM := bytes.NewBuffer([]byte{}) | ||
| err = pem.Encode(csrPEM, &pem.Block{Type: "CERTIFICATE REQUEST", Bytes: csrDER}) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| return csrPEM.Bytes() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters