New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
signerName: extend client-go ensureCompatibility and additional unit tests #88760
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
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
146 changes: 146 additions & 0 deletions
146
staging/src/k8s.io/client-go/util/certificate/csr/csr_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,146 @@ | ||
| /* | ||
| Copyright 2020 The Kubernetes 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 csr | ||
|
|
||
| import ( | ||
| "crypto" | ||
| "crypto/rand" | ||
| "crypto/rsa" | ||
| "crypto/x509" | ||
| "crypto/x509/pkix" | ||
| "encoding/pem" | ||
| "testing" | ||
|
|
||
| certificates "k8s.io/api/certificates/v1beta1" | ||
| "k8s.io/utils/pointer" | ||
| ) | ||
|
|
||
| func TestEnsureCompatible(t *testing.T) { | ||
| privateKey, err := rsa.GenerateKey(rand.Reader, 2048) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| req := pemWithPrivateKey(privateKey) | ||
|
|
||
| tests := map[string]struct { | ||
| new, orig *certificates.CertificateSigningRequest | ||
| privateKey interface{} | ||
| err string | ||
| }{ | ||
| "nil signerName on 'new' matches any signerName on 'orig'": { | ||
| new: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| }, | ||
| }, | ||
| orig: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| SignerName: pointer.StringPtr("example.com/test"), | ||
| }, | ||
| }, | ||
| privateKey: privateKey, | ||
| }, | ||
| "nil signerName on 'orig' matches any signerName on 'new'": { | ||
| new: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| SignerName: pointer.StringPtr("example.com/test"), | ||
| }, | ||
| }, | ||
| orig: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| }, | ||
| }, | ||
| privateKey: privateKey, | ||
| }, | ||
| "signerName on 'orig' matches signerName on 'new'": { | ||
| new: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| SignerName: pointer.StringPtr("example.com/test"), | ||
| }, | ||
| }, | ||
| orig: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| SignerName: pointer.StringPtr("example.com/test"), | ||
| }, | ||
| }, | ||
| privateKey: privateKey, | ||
| }, | ||
| "signerName on 'orig' does not match signerName on 'new'": { | ||
| new: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| SignerName: pointer.StringPtr("example.com/test"), | ||
| }, | ||
| }, | ||
| orig: &certificates.CertificateSigningRequest{ | ||
| Spec: certificates.CertificateSigningRequestSpec{ | ||
| Request: req, | ||
| SignerName: pointer.StringPtr("example.com/not-test"), | ||
| }, | ||
| }, | ||
| privateKey: privateKey, | ||
| err: `csr signerNames differ: new "example.com/test", orig: "example.com/not-test"`, | ||
| }, | ||
| } | ||
| for name, test := range tests { | ||
| t.Run(name, func(t *testing.T) { | ||
| err := ensureCompatible(test.new, test.orig, test.privateKey) | ||
| if err != nil && test.err == "" { | ||
| t.Errorf("expected no error, but got: %v", err) | ||
| } else if err != nil && test.err != err.Error() { | ||
| t.Errorf("error did not match as expected, got=%v, exp=%s", err, test.err) | ||
| } | ||
| if err == nil && test.err != "" { | ||
| t.Errorf("expected to get an error but got none") | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func pemWithPrivateKey(pk crypto.PrivateKey) []byte { | ||
| template := &x509.CertificateRequest{ | ||
| Subject: pkix.Name{ | ||
| CommonName: "something", | ||
| Organization: []string{"test"}, | ||
| }, | ||
| } | ||
| return pemWithTemplate(template, pk) | ||
| } | ||
|
|
||
| func pemWithTemplate(template *x509.CertificateRequest, key crypto.PrivateKey) []byte { | ||
| csrDER, err := x509.CreateCertificateRequest(rand.Reader, template, key) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| csrPemBlock := &pem.Block{ | ||
| Type: "CERTIFICATE REQUEST", | ||
| Bytes: csrDER, | ||
| } | ||
|
|
||
| p := pem.EncodeToMemory(csrPemBlock) | ||
| if p == nil { | ||
| panic("invalid pem block") | ||
| } | ||
|
|
||
| return p | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's worth noting that
RequestCertificateacceptssignerNameas astring, which means thatorigcan never benilhere. @liggitt was it a mistake that I made signerName (the arg) a non-ptr? Is it ever desirable to allow people to mark it as nil and defer the decision to the apiserver?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, making callers understand and choose their signer matches my expectations and the likely shape of the v1 API.