-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding certwatcher as external package
Signed-off-by: Chris Hein <me@chrishein.com>
- Loading branch information
1 parent
b5065bd
commit a93a723
Showing
7 changed files
with
343 additions
and
5 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
/* | ||
Copyright 2021 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 certwatcher_test | ||
|
||
import ( | ||
"os" | ||
"testing" | ||
|
||
. "github.com/onsi/ginkgo" | ||
. "github.com/onsi/gomega" | ||
"sigs.k8s.io/controller-runtime/pkg/envtest/printer" | ||
logf "sigs.k8s.io/controller-runtime/pkg/log" | ||
"sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
) | ||
|
||
var ( | ||
certPath = "testdata/tls.crt" | ||
keyPath = "testdata/tls.key" | ||
) | ||
|
||
func TestSource(t *testing.T) { | ||
RegisterFailHandler(Fail) | ||
suiteName := "CertWatcher Suite" | ||
RunSpecsWithDefaultAndCustomReporters(t, suiteName, []Reporter{printer.NewlineReporter{}, printer.NewProwReporter(suiteName)}) | ||
} | ||
|
||
var _ = BeforeSuite(func(done Done) { | ||
logf.SetLogger(zap.New(zap.WriteTo(GinkgoWriter), zap.UseDevMode(true))) | ||
|
||
close(done) | ||
}, 60) | ||
|
||
var _ = AfterSuite(func(done Done) { | ||
for _, file := range []string{certPath, keyPath} { | ||
_ = os.Remove(file) | ||
} | ||
close(done) | ||
}, 60) |
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,187 @@ | ||
/* | ||
Copyright 2021 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 certwatcher_test | ||
|
||
import ( | ||
"context" | ||
"crypto/rand" | ||
"crypto/rsa" | ||
"crypto/x509" | ||
"crypto/x509/pkix" | ||
"encoding/pem" | ||
"math/big" | ||
"net" | ||
"os" | ||
"time" | ||
|
||
. "github.com/onsi/ginkgo" | ||
. "github.com/onsi/gomega" | ||
"sigs.k8s.io/controller-runtime/pkg/certwatcher" | ||
) | ||
|
||
var _ = Describe("CertWatcher", func() { | ||
var _ = Describe("certwatcher New", func() { | ||
It("should errors without cert/key", func() { | ||
_, err := certwatcher.New("", "") | ||
Expect(err).ToNot(BeNil()) | ||
}) | ||
}) | ||
|
||
var _ = Describe("certwatcher Start", func() { | ||
var ( | ||
ctx context.Context | ||
ctxCancel context.CancelFunc | ||
watcher *certwatcher.CertWatcher | ||
) | ||
|
||
BeforeEach(func() { | ||
ctx, ctxCancel = context.WithCancel(context.Background()) | ||
|
||
err := writeCerts(certPath, keyPath, "127.0.0.1") | ||
Expect(err).To(BeNil()) | ||
|
||
Eventually(func() error { | ||
for _, file := range []string{certPath, keyPath} { | ||
_, err := os.ReadFile(file) | ||
if err != nil { | ||
return err | ||
} | ||
continue | ||
} | ||
|
||
return nil | ||
}).Should(Succeed()) | ||
|
||
watcher, err = certwatcher.New(certPath, keyPath) | ||
Expect(err).To(BeNil()) | ||
}) | ||
|
||
startWatcher := func() (done <-chan struct{}) { | ||
doneCh := make(chan struct{}) | ||
go func() { | ||
defer GinkgoRecover() | ||
defer close(doneCh) | ||
Expect(watcher.Start(ctx)).To(Succeed()) | ||
}() | ||
// wait till we read first cert | ||
Eventually(func() error { | ||
err := watcher.ReadCertificate() | ||
return err | ||
}).Should(Succeed()) | ||
return doneCh | ||
} | ||
|
||
It("should read the initial cert/key", func() { | ||
doneCh := startWatcher() | ||
|
||
ctxCancel() | ||
Eventually(doneCh, "4s").Should(BeClosed()) | ||
}) | ||
|
||
It("should reload currentCert when changed", func() { | ||
doneCh := startWatcher() | ||
|
||
firstcert, _ := watcher.GetCertificate(nil) | ||
|
||
err := writeCerts(certPath, keyPath, "192.168.0.1") | ||
Expect(err).To(BeNil()) | ||
|
||
Eventually(func() bool { | ||
secondcert, _ := watcher.GetCertificate(nil) | ||
first := firstcert.PrivateKey.(*rsa.PrivateKey) | ||
return first.Equal(secondcert.PrivateKey) | ||
}).ShouldNot(BeTrue()) | ||
|
||
ctxCancel() | ||
Eventually(doneCh, "4s").Should(BeClosed()) | ||
}) | ||
}) | ||
}) | ||
|
||
func writeCerts(certPath, keyPath, ip string) error { | ||
var priv interface{} | ||
var err error | ||
priv, err = rsa.GenerateKey(rand.Reader, 2048) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
keyUsage := x509.KeyUsageDigitalSignature | ||
if _, isRSA := priv.(*rsa.PrivateKey); isRSA { | ||
keyUsage |= x509.KeyUsageKeyEncipherment | ||
} | ||
|
||
var notBefore time.Time | ||
notBefore = time.Now() | ||
|
||
notAfter := notBefore.Add(1 * time.Hour) | ||
|
||
serialNumberLimit := new(big.Int).Lsh(big.NewInt(1), 128) | ||
serialNumber, err := rand.Int(rand.Reader, serialNumberLimit) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
template := x509.Certificate{ | ||
SerialNumber: serialNumber, | ||
Subject: pkix.Name{ | ||
Organization: []string{"Kubernetes"}, | ||
}, | ||
NotBefore: notBefore, | ||
NotAfter: notAfter, | ||
|
||
KeyUsage: keyUsage, | ||
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}, | ||
BasicConstraintsValid: true, | ||
} | ||
|
||
template.IPAddresses = append(template.IPAddresses, net.ParseIP(ip)) | ||
|
||
privkey := priv.(*rsa.PrivateKey) | ||
|
||
derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, &privkey.PublicKey, priv) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
certOut, err := os.Create(certPath) | ||
if err != nil { | ||
return err | ||
} | ||
if err := pem.Encode(certOut, &pem.Block{Type: "CERTIFICATE", Bytes: derBytes}); err != nil { | ||
return err | ||
} | ||
if err := certOut.Close(); err != nil { | ||
return err | ||
} | ||
|
||
keyOut, err := os.OpenFile(keyPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600) | ||
if err != nil { | ||
return err | ||
} | ||
privBytes, err := x509.MarshalPKCS8PrivateKey(priv) | ||
if err != nil { | ||
return err | ||
} | ||
if err := pem.Encode(keyOut, &pem.Block{Type: "PRIVATE KEY", Bytes: privBytes}); err != nil { | ||
return err | ||
} | ||
if err := keyOut.Close(); err != nil { | ||
return err | ||
} | ||
return nil | ||
} |
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,23 @@ | ||
/* | ||
Copyright 2021 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 certwatcher is a helper for reloading Certificates from disk to be used | ||
with tls servers. It provides a helper func `GetCertificate` which can be | ||
called from `tls.Config` and passed into your tls.Listener. For a detailed | ||
example server view pkg/webhook/server.go. | ||
*/ | ||
package certwatcher |
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,76 @@ | ||
/* | ||
Copyright 2018 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 certwatcher_test | ||
|
||
import ( | ||
"context" | ||
"crypto/tls" | ||
"net/http" | ||
|
||
ctrl "sigs.k8s.io/controller-runtime" | ||
"sigs.k8s.io/controller-runtime/pkg/certwatcher" | ||
) | ||
|
||
type sampleServer struct { | ||
} | ||
|
||
func Example() { | ||
// Setup Context | ||
ctx := ctrl.SetupSignalHandler() | ||
|
||
// Initialize a new cert watcher with cert/key pari | ||
watcher, err := certwatcher.New("ssl/tls.crt", "ssl/tls.key") | ||
if err != nil { | ||
panic(err) | ||
} | ||
|
||
// Start goroutine with certwatcher running fsnotify against supplied certdir | ||
go func() { | ||
if err := watcher.Start(ctx); err != nil { | ||
panic(err) | ||
} | ||
}() | ||
|
||
// Setup TLS listener using GetCertficate for fetching the cert when changes | ||
listener, err := tls.Listen("tcp", "localhost:9443", &tls.Config{ | ||
GetCertificate: watcher.GetCertificate, | ||
}) | ||
if err != nil { | ||
panic(err) | ||
} | ||
|
||
// Initialize your tls server | ||
srv := &http.Server{ | ||
Handler: &sampleServer{}, | ||
} | ||
|
||
// Start goroutine for handling server shutdown. | ||
go func() { | ||
<-ctx.Done() | ||
if err := srv.Shutdown(context.Background()); err != nil { | ||
panic(err) | ||
} | ||
}() | ||
|
||
// Serve t | ||
if err := srv.Serve(listener); err != nil && err != http.ErrServerClosed { | ||
panic(err) | ||
} | ||
} | ||
|
||
func (s *sampleServer) ServeHTTP(http.ResponseWriter, *http.Request) { | ||
} |
Empty file.
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