-
Notifications
You must be signed in to change notification settings - Fork 31
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
Added option to use custom TLS certificates instead of ACME #17
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
599c610
Added option to use custom TLS certificates instead of ACME
kpumuk f1be705
Use ServiceOptions from deploy command directly
kpumuk 085b924
Added test to make sure service uses static certificate manager when …
kpumuk aceaede
Cache a certificate loaded from disk in the StaticCertManager
kpumuk 7937791
Added tests for invalid scenarios in the StaticCertManager
kpumuk 233625e
More expressive test for the cert manager type in the service test
kpumuk 3d24ed2
Addressed a data race condition in the StaticCertManager, and added a…
kpumuk 749e110
Use t.Cleanup() to remove temporary certificate files after the test …
kpumuk 7e7126c
Ensure all IO errors are handled in the StaticCertManager test
kpumuk f2f6f9c
Added missing help for --tls-certificate-path and --tls-private-key-p…
kpumuk 30b8c20
Added HTTPHandler() to the CertManager interface after support for HT…
kpumuk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
package server | ||
|
||
import ( | ||
"crypto/tls" | ||
"log/slog" | ||
"net/http" | ||
"sync" | ||
) | ||
|
||
type CertManager interface { | ||
GetCertificate(hello *tls.ClientHelloInfo) (*tls.Certificate, error) | ||
HTTPHandler(handler http.Handler) http.Handler | ||
} | ||
|
||
// StaticCertManager is a certificate manager that loads certificates from disk. | ||
type StaticCertManager struct { | ||
tlsCertificateFilePath string | ||
tlsPrivateKeyFilePath string | ||
cert *tls.Certificate | ||
lock sync.RWMutex | ||
} | ||
|
||
func NewStaticCertManager(tlsCertificateFilePath, tlsPrivateKeyFilePath string) *StaticCertManager { | ||
return &StaticCertManager{ | ||
tlsCertificateFilePath: tlsCertificateFilePath, | ||
tlsPrivateKeyFilePath: tlsPrivateKeyFilePath, | ||
} | ||
} | ||
|
||
func (m *StaticCertManager) GetCertificate(*tls.ClientHelloInfo) (*tls.Certificate, error) { | ||
m.lock.RLock() | ||
if m.cert != nil { | ||
defer m.lock.RUnlock() | ||
return m.cert, nil | ||
} | ||
m.lock.RUnlock() | ||
|
||
m.lock.Lock() | ||
defer m.lock.Unlock() | ||
if m.cert != nil { // Double-check locking | ||
return m.cert, nil | ||
} | ||
|
||
slog.Info( | ||
"Loading custom TLS certificate", | ||
"tls-certificate-path", m.tlsCertificateFilePath, | ||
"tls-private-key-path", m.tlsPrivateKeyFilePath, | ||
) | ||
|
||
cert, err := tls.LoadX509KeyPair(m.tlsCertificateFilePath, m.tlsPrivateKeyFilePath) | ||
if err != nil { | ||
return nil, err | ||
} | ||
m.cert = &cert | ||
|
||
return m.cert, nil | ||
} | ||
|
||
func (m *StaticCertManager) HTTPHandler(handler http.Handler) http.Handler { | ||
return handler | ||
} |
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,105 @@ | ||
package server | ||
|
||
import ( | ||
"crypto/tls" | ||
"os" | ||
"path" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
const certPem = `-----BEGIN CERTIFICATE----- | ||
MIIBhTCCASugAwIBAgIQIRi6zePL6mKjOipn+dNuaTAKBggqhkjOPQQDAjASMRAw | ||
DgYDVQQKEwdBY21lIENvMB4XDTE3MTAyMDE5NDMwNloXDTE4MTAyMDE5NDMwNlow | ||
EjEQMA4GA1UEChMHQWNtZSBDbzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABD0d | ||
7VNhbWvZLWPuj/RtHFjvtJBEwOkhbN/BnnE8rnZR8+sbwnc/KhCk3FhnpHZnQz7B | ||
5aETbbIgmuvewdjvSBSjYzBhMA4GA1UdDwEB/wQEAwICpDATBgNVHSUEDDAKBggr | ||
BgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MCkGA1UdEQQiMCCCDmxvY2FsaG9zdDo1 | ||
NDUzgg4xMjcuMC4wLjE6NTQ1MzAKBggqhkjOPQQDAgNIADBFAiEA2zpJEPQyz6/l | ||
Wf86aX6PepsntZv2GYlA5UpabfT2EZICICpJ5h/iI+i341gBmLiAFQOyTDT+/wQc | ||
6MF9+Yw1Yy0t | ||
-----END CERTIFICATE-----` | ||
|
||
const keyPem = `-----BEGIN EC PRIVATE KEY----- | ||
MHcCAQEEIIrYSSNQFaA2Hwf1duRSxKtLYX5CB04fSeQ6tF1aY/PuoAoGCCqGSM49 | ||
AwEHoUQDQgAEPR3tU2Fta9ktY+6P9G0cWO+0kETA6SFs38GecTyudlHz6xvCdz8q | ||
EKTcWGekdmdDPsHloRNtsiCa697B2O9IFA== | ||
-----END EC PRIVATE KEY-----` | ||
|
||
func TestCertificateLoading(t *testing.T) { | ||
certPath, keyPath, err := prepareTestCertificateFiles(t) | ||
require.NoError(t, err) | ||
|
||
manager := NewStaticCertManager(certPath, keyPath) | ||
cert, err := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.NoError(t, err) | ||
require.NotNil(t, cert) | ||
} | ||
|
||
func TestCertificateLoadingRaceCondition(t *testing.T) { | ||
certPath, keyPath, err := prepareTestCertificateFiles(t) | ||
require.NoError(t, err) | ||
|
||
manager := NewStaticCertManager(certPath, keyPath) | ||
go func() { | ||
_, err2 := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.NoError(t, err2) | ||
}() | ||
cert, err := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.NoError(t, err) | ||
require.NotNil(t, cert) | ||
} | ||
|
||
func TestCachesLoadedCertificate(t *testing.T) { | ||
certPath, keyPath, err := prepareTestCertificateFiles(t) | ||
require.NoError(t, err) | ||
|
||
manager := NewStaticCertManager(certPath, keyPath) | ||
cert1, err := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.NoError(t, err) | ||
require.NotNil(t, cert1) | ||
|
||
require.Nil(t, os.Remove(certPath)) | ||
require.Nil(t, os.Remove(keyPath)) | ||
|
||
cert2, err := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.Equal(t, cert1, cert2) | ||
} | ||
|
||
func TestErrorWhenFileDoesNotExist(t *testing.T) { | ||
manager := NewStaticCertManager("testdata/cert.pem", "testdata/key.pem") | ||
cert1, err := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.ErrorContains(t, err, "no such file or directory") | ||
require.Nil(t, cert1) | ||
} | ||
|
||
func TestErrorWhenKeyFormatIsInvalid(t *testing.T) { | ||
certPath, keyPath, err := prepareTestCertificateFiles(t) | ||
require.NoError(t, err) | ||
|
||
manager := NewStaticCertManager(keyPath, certPath) | ||
cert1, err := manager.GetCertificate(&tls.ClientHelloInfo{}) | ||
require.ErrorContains(t, err, "failed to find certificate PEM data in certificate input") | ||
require.Nil(t, cert1) | ||
} | ||
|
||
func prepareTestCertificateFiles(t *testing.T) (string, string, error) { | ||
t.Helper() | ||
|
||
dir := t.TempDir() | ||
certFile := path.Join(dir, "example-cert.pem") | ||
keyFile := path.Join(dir, "example-key.pem") | ||
|
||
err := os.WriteFile(certFile, []byte(certPem), 0644) | ||
if err != nil { | ||
return "", "", err | ||
} | ||
|
||
err = os.WriteFile(keyFile, []byte(keyPem), 0644) | ||
if err != nil { | ||
return "", "", err | ||
} | ||
|
||
return certFile, keyFile, 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
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
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.
This will be called for every TLS handshake, which means the certificate files will be loaded multiple times. Better to load the certificate when the
StaticCertManager
is established, and reuse it for the lifetime of the deployment.That would also let us catch a loading error early on, and fail the deployment at that point, which would be safer.
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.
That would require more changes, as we right now do not expect
createCertManager()
to ever return an error.Another option would be to cache the certificate on first use:
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.
Applied the patch and added a test. Let me know what you think
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.
Thinking about this, might need a mutex since there might be multiple procs loading certs at the same time.
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.
Confirmed, will work on a fix:
Output of
go test ./... -race
: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.
Introduced an
RWMutex
in f1df35f to address itThere 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.
Another option to avoid the mutex would be to attempt the file load in the
NewStaticCertManager
, and then save both the error and the response in the struct.GetCertificate
would just return both, avoiding a delayed load, the need for mutex, etc.This design might limit the options for (potential) future changes, like reloading the certificate on file change.