-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Watch TLS cert file changes to update certs when needed. (#20)
- Loading branch information
Showing
5 changed files
with
215 additions
and
17 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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| /* | ||
| 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 | ||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/tls" | ||
| "log" | ||
| "sync" | ||
|
|
||
| "github.com/fsnotify/fsnotify" | ||
| ) | ||
|
|
||
| var ( | ||
| VerboseLogs bool | ||
| Logger *log.Logger | ||
| ) | ||
|
|
||
| func logf(format string, args ...any) { | ||
| if Logger != nil { | ||
| Logger.Printf(format, args...) | ||
| } else { | ||
| log.Printf(format, args...) | ||
| } | ||
| } | ||
|
|
||
| func vlogf(format string, args ...any) { | ||
| if VerboseLogs { | ||
| logf(format, args...) | ||
| } | ||
| } | ||
|
|
||
| // CertWatcher watches certificate and key files for changes. When either file | ||
| // changes, it reads and parses both and calls an optional callback with the new | ||
| // certificate. | ||
| type CertWatcher struct { | ||
| sync.RWMutex | ||
|
|
||
| currentCert *tls.Certificate | ||
| watcher *fsnotify.Watcher | ||
|
|
||
| certPath string | ||
| keyPath string | ||
| } | ||
|
|
||
| // New returns a new CertWatcher watching the given certificate and key. | ||
| func New(certPath, keyPath string) (*CertWatcher, error) { | ||
| var err error | ||
|
|
||
| cw := &CertWatcher{ | ||
| certPath: certPath, | ||
| keyPath: keyPath, | ||
| } | ||
|
|
||
| // Initial read of certificate and key. | ||
| if err := cw.ReadCertificate(); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cw.watcher, err = fsnotify.NewWatcher() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return cw, nil | ||
| } | ||
|
|
||
| // GetCertificate fetches the currently loaded certificate, which may be nil. | ||
| func (cw *CertWatcher) GetCertificate(_ *tls.ClientHelloInfo) (*tls.Certificate, error) { | ||
| cw.RLock() | ||
| defer cw.RUnlock() | ||
| return cw.currentCert, nil | ||
| } | ||
|
|
||
| // Start starts the watch on the certificate and key files. | ||
| func (cw *CertWatcher) Start(ctx context.Context) error { | ||
| files := []string{cw.certPath, cw.keyPath} | ||
|
|
||
| for _, f := range files { | ||
| if err := cw.watcher.Add(f); err != nil { | ||
| logf("error watching file: %s", err) | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| go cw.Watch() | ||
|
|
||
| // Block until the context is done. | ||
| <-ctx.Done() | ||
|
|
||
| return cw.watcher.Close() | ||
| } | ||
|
|
||
| // Watch reads events from the watcher's channel and reacts to changes. | ||
| func (cw *CertWatcher) Watch() { | ||
| for { | ||
| select { | ||
| case event, ok := <-cw.watcher.Events: | ||
| // Channel is closed. | ||
| if !ok { | ||
| return | ||
| } | ||
|
|
||
| cw.handleEvent(event) | ||
|
|
||
| case err, ok := <-cw.watcher.Errors: | ||
| // Channel is closed. | ||
| if !ok { | ||
| return | ||
| } | ||
|
|
||
| logf("certificate watch error: %s", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // ReadCertificate reads the certificate and key files from disk, parses them, | ||
| // and updates the current certificate on the watcher. If a callback is set, it | ||
| // is invoked with the new certificate. | ||
| func (cw *CertWatcher) ReadCertificate() error { | ||
| cert, err := tls.LoadX509KeyPair(cw.certPath, cw.keyPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| cw.Lock() | ||
| cw.currentCert = &cert | ||
| cw.Unlock() | ||
|
|
||
| vlogf("updated current TLS certificate") | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (cw *CertWatcher) handleEvent(event fsnotify.Event) { | ||
| // Only care about events which may modify the contents of the file. | ||
| if !(isWrite(event) || isRemove(event) || isCreate(event)) { | ||
| return | ||
| } | ||
|
|
||
| vlogf("certificate event: %s", event) | ||
|
|
||
| // If the file was removed, re-add the watch. | ||
| if isRemove(event) { | ||
| if err := cw.watcher.Add(event.Name); err != nil { | ||
| logf("error re-watching file: %s", err) | ||
| } | ||
| } | ||
|
|
||
| if err := cw.ReadCertificate(); err != nil { | ||
| logf("error re-reading certificate: %s", err) | ||
| } | ||
| } | ||
|
|
||
| func isWrite(event fsnotify.Event) bool { | ||
| return event.Op&fsnotify.Write == fsnotify.Write | ||
| } | ||
|
|
||
| func isCreate(event fsnotify.Event) bool { | ||
| return event.Op&fsnotify.Create == fsnotify.Create | ||
| } | ||
|
|
||
| func isRemove(event fsnotify.Event) bool { | ||
| return event.Op&fsnotify.Remove == fsnotify.Remove | ||
| } |