Refactor: Use persistent cert storage with reuse logic

Co-authored-by: warkanum <208308+warkanum@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-12-30 11:12:21 +00:00
parent 64f56325d4
commit ccf8522f88
3 changed files with 165 additions and 75 deletions

View File

@@ -369,9 +369,8 @@ func (sm *serverManager) ServeWithGracefulShutdown() error {
type serverInstance struct { type serverInstance struct {
cfg Config cfg Config
gracefulServer *gracefulServer gracefulServer *gracefulServer
certFile string // Path to certificate file (may be temporary for self-signed) certFile string // Path to certificate file (may be persistent for self-signed)
keyFile string // Path to key file (may be temporary for self-signed) keyFile string // Path to key file (may be persistent for self-signed)
tempCertDir string // Path to temporary certificate directory (for cleanup)
mu sync.RWMutex mu sync.RWMutex
running bool running bool
serverErr chan error serverErr chan error
@@ -416,7 +415,7 @@ func newInstance(cfg Config) (*serverInstance, error) {
handler = middleware.PanicRecovery(handler) handler = middleware.PanicRecovery(handler)
// Configure TLS if any TLS option is enabled // Configure TLS if any TLS option is enabled
tlsConfig, certFile, keyFile, tempCertDir, err := configureTLS(cfg) tlsConfig, certFile, keyFile, err := configureTLS(cfg)
if err != nil { if err != nil {
return nil, fmt.Errorf("failed to configure TLS: %w", err) return nil, fmt.Errorf("failed to configure TLS: %w", err)
} }
@@ -441,7 +440,6 @@ func newInstance(cfg Config) (*serverInstance, error) {
gracefulServer: gracefulSrv, gracefulServer: gracefulSrv,
certFile: certFile, certFile: certFile,
keyFile: keyFile, keyFile: keyFile,
tempCertDir: tempCertDir,
serverErr: make(chan error, 1), serverErr: make(chan error, 1),
}, nil }, nil
} }
@@ -535,20 +533,6 @@ func (s *serverInstance) Stop(ctx context.Context) error {
if err == nil { if err == nil {
s.running = false s.running = false
} }
// Clean up temporary certificate directory if it exists
if s.tempCertDir != "" {
if cleanupErr := os.RemoveAll(s.tempCertDir); cleanupErr != nil {
logger.Error("Failed to clean up temporary certificate directory '%s': %v", s.tempCertDir, cleanupErr)
// Don't override the shutdown error with cleanup error
if err == nil {
err = fmt.Errorf("failed to clean up temporary certificates: %w", cleanupErr)
}
} else {
logger.Info("Cleaned up temporary certificate directory for server '%s'", s.cfg.Name)
}
}
return err return err
} }

View File

@@ -7,6 +7,7 @@ import (
"net" "net"
"net/http" "net/http"
"os" "os"
"path/filepath"
"sync" "sync"
"testing" "testing"
"time" "time"
@@ -328,41 +329,70 @@ func TestShutdownCallbacks(t *testing.T) {
assert.True(t, executed, "Shutdown callback should have been executed") assert.True(t, executed, "Shutdown callback should have been executed")
} }
func TestSelfSignedSSLCleanup(t *testing.T) { func TestSelfSignedSSLCertificateReuse(t *testing.T) {
logger.Init(true) logger.Init(true)
sm := NewManager()
testPort := getFreePort(t) // Get cert directory to verify file creation
instance, err := sm.Add(Config{ certDir, err := getCertDirectory()
Name: "SSLTestServer", require.NoError(t, err)
Host: "localhost",
Port: testPort, host := "localhost"
certFile := filepath.Join(certDir, fmt.Sprintf("%s-cert.pem", host))
keyFile := filepath.Join(certDir, fmt.Sprintf("%s-key.pem", host))
// Clean up any existing cert files from previous tests
os.Remove(certFile)
os.Remove(keyFile)
// First server creation - should generate new certificates
sm1 := NewManager()
testPort1 := getFreePort(t)
_, err = sm1.Add(Config{
Name: "SSLTestServer1",
Host: host,
Port: testPort1,
Handler: http.NewServeMux(), Handler: http.NewServeMux(),
SelfSignedSSL: true, SelfSignedSSL: true,
ShutdownTimeout: 5 * time.Second, ShutdownTimeout: 5 * time.Second,
}) })
require.NoError(t, err) require.NoError(t, err)
// Get the serverInstance to access the tempCertDir // Verify certificates were created
si, ok := instance.(*serverInstance) _, err = os.Stat(certFile)
require.True(t, ok, "instance should be of type *serverInstance") require.NoError(t, err, "certificate file should exist after first creation")
require.NotEmpty(t, si.tempCertDir, "temporary certificate directory should be set") _, err = os.Stat(keyFile)
require.NoError(t, err, "key file should exist after first creation")
// Verify the temp directory exists // Get modification time of cert file
_, err = os.Stat(si.tempCertDir) info1, err := os.Stat(certFile)
require.NoError(t, err, "temporary certificate directory should exist")
// Start the server
err = sm.StartAll()
require.NoError(t, err) require.NoError(t, err)
modTime1 := info1.ModTime()
// Wait a bit to ensure different modification times
time.Sleep(100 * time.Millisecond) time.Sleep(100 * time.Millisecond)
// Stop the server // Second server creation - should reuse existing certificates
err = sm.StopAll() sm2 := NewManager()
testPort2 := getFreePort(t)
_, err = sm2.Add(Config{
Name: "SSLTestServer2",
Host: host,
Port: testPort2,
Handler: http.NewServeMux(),
SelfSignedSSL: true,
ShutdownTimeout: 5 * time.Second,
})
require.NoError(t, err) require.NoError(t, err)
// Verify the temp directory has been cleaned up // Get modification time of cert file after second creation
_, err = os.Stat(si.tempCertDir) info2, err := os.Stat(certFile)
assert.True(t, os.IsNotExist(err), "temporary certificate directory should be cleaned up after shutdown") require.NoError(t, err)
modTime2 := info2.ModTime()
// Verify the certificate was reused (same modification time)
assert.Equal(t, modTime1, modTime2, "certificate should be reused, not regenerated")
// Clean up
sm1.StopAll()
sm2.StopAll()
} }

View File

@@ -75,31 +75,85 @@ func generateSelfSignedCert(host string) (certPEM, keyPEM []byte, err error) {
return certPEM, keyPEM, nil return certPEM, keyPEM, nil
} }
// saveCertToTempFiles saves certificate and key PEM data to temporary files. // getCertDirectory returns the directory path for storing self-signed certificates.
// Returns the file paths for the certificate and key, and the temporary directory path. // Creates the directory if it doesn't exist.
func saveCertToTempFiles(certPEM, keyPEM []byte) (certFile, keyFile, tmpDir string, err error) { func getCertDirectory() (string, error) {
// Create temporary directory // Use a consistent directory in the user's cache directory
tmpDir, err = os.MkdirTemp("", "resolvespec-certs-*") cacheDir, err := os.UserCacheDir()
if err != nil { if err != nil {
return "", "", "", fmt.Errorf("failed to create temp directory: %w", err) // Fallback to current directory if cache dir is not available
cacheDir = "."
} }
certFile = filepath.Join(tmpDir, "cert.pem") certDir := filepath.Join(cacheDir, "resolvespec", "certs")
keyFile = filepath.Join(tmpDir, "key.pem")
// Create directory if it doesn't exist
if err := os.MkdirAll(certDir, 0700); err != nil {
return "", fmt.Errorf("failed to create certificate directory: %w", err)
}
return certDir, nil
}
// isCertificateValid checks if a certificate file exists and is not expired.
func isCertificateValid(certFile string) bool {
// Check if file exists
certData, err := os.ReadFile(certFile)
if err != nil {
return false
}
// Parse certificate
block, _ := pem.Decode(certData)
if block == nil {
return false
}
cert, err := x509.ParseCertificate(block.Bytes)
if err != nil {
return false
}
// Check if certificate is expired or will expire in the next 30 days
now := time.Now()
expiryThreshold := now.Add(30 * 24 * time.Hour)
if now.Before(cert.NotBefore) || now.After(cert.NotAfter) {
return false
}
// Renew if expiring soon
if expiryThreshold.After(cert.NotAfter) {
return false
}
return true
}
// saveCertToFiles saves certificate and key PEM data to persistent files.
// Returns the file paths for the certificate and key.
func saveCertToFiles(certPEM, keyPEM []byte, host string) (certFile, keyFile string, err error) {
// Get certificate directory
certDir, err := getCertDirectory()
if err != nil {
return "", "", err
}
// Use consistent file names based on host
certFile = filepath.Join(certDir, fmt.Sprintf("%s-cert.pem", host))
keyFile = filepath.Join(certDir, fmt.Sprintf("%s-key.pem", host))
// Write certificate // Write certificate
if err := os.WriteFile(certFile, certPEM, 0600); err != nil { if err := os.WriteFile(certFile, certPEM, 0600); err != nil {
os.RemoveAll(tmpDir) return "", "", fmt.Errorf("failed to write certificate: %w", err)
return "", "", "", fmt.Errorf("failed to write certificate: %w", err)
} }
// Write key // Write key
if err := os.WriteFile(keyFile, keyPEM, 0600); err != nil { if err := os.WriteFile(keyFile, keyPEM, 0600); err != nil {
os.RemoveAll(tmpDir) return "", "", fmt.Errorf("failed to write private key: %w", err)
return "", "", "", fmt.Errorf("failed to write private key: %w", err)
} }
return certFile, keyFile, tmpDir, nil return certFile, keyFile, nil
} }
// setupAutoTLS configures automatic TLS certificate management using Let's Encrypt. // setupAutoTLS configures automatic TLS certificate management using Let's Encrypt.
@@ -135,32 +189,32 @@ func setupAutoTLS(domains []string, email, cacheDir string) (*tls.Config, error)
} }
// configureTLS configures TLS for the server based on the provided configuration. // configureTLS configures TLS for the server based on the provided configuration.
// Returns the TLS config, certificate/key file paths (if applicable), and temp directory path (if applicable). // Returns the TLS config and certificate/key file paths (if applicable).
func configureTLS(cfg Config) (*tls.Config, string, string, string, error) { func configureTLS(cfg Config) (*tls.Config, string, string, error) {
// Option 1: Certificate files provided // Option 1: Certificate files provided
if cfg.SSLCert != "" && cfg.SSLKey != "" { if cfg.SSLCert != "" && cfg.SSLKey != "" {
// Validate that files exist // Validate that files exist
if _, err := os.Stat(cfg.SSLCert); os.IsNotExist(err) { if _, err := os.Stat(cfg.SSLCert); os.IsNotExist(err) {
return nil, "", "", "", fmt.Errorf("SSL certificate file not found: %s", cfg.SSLCert) return nil, "", "", fmt.Errorf("SSL certificate file not found: %s", cfg.SSLCert)
} }
if _, err := os.Stat(cfg.SSLKey); os.IsNotExist(err) { if _, err := os.Stat(cfg.SSLKey); os.IsNotExist(err) {
return nil, "", "", "", fmt.Errorf("SSL key file not found: %s", cfg.SSLKey) return nil, "", "", fmt.Errorf("SSL key file not found: %s", cfg.SSLKey)
} }
// Return basic TLS config - cert/key will be loaded by ListenAndServeTLS // Return basic TLS config - cert/key will be loaded by ListenAndServeTLS
tlsConfig := &tls.Config{ tlsConfig := &tls.Config{
MinVersion: tls.VersionTLS12, MinVersion: tls.VersionTLS12,
} }
return tlsConfig, cfg.SSLCert, cfg.SSLKey, "", nil return tlsConfig, cfg.SSLCert, cfg.SSLKey, nil
} }
// Option 2: Auto TLS (Let's Encrypt) // Option 2: Auto TLS (Let's Encrypt)
if cfg.AutoTLS { if cfg.AutoTLS {
tlsConfig, err := setupAutoTLS(cfg.AutoTLSDomains, cfg.AutoTLSEmail, cfg.AutoTLSCacheDir) tlsConfig, err := setupAutoTLS(cfg.AutoTLSDomains, cfg.AutoTLSEmail, cfg.AutoTLSCacheDir)
if err != nil { if err != nil {
return nil, "", "", "", fmt.Errorf("failed to setup AutoTLS: %w", err) return nil, "", "", fmt.Errorf("failed to setup AutoTLS: %w", err)
} }
return tlsConfig, "", "", "", nil return tlsConfig, "", "", nil
} }
// Option 3: Self-signed certificate // Option 3: Self-signed certificate
@@ -170,21 +224,43 @@ func configureTLS(cfg Config) (*tls.Config, string, string, string, error) {
host = "localhost" host = "localhost"
} }
certPEM, keyPEM, err := generateSelfSignedCert(host) // Get certificate directory
certDir, err := getCertDirectory()
if err != nil { if err != nil {
return nil, "", "", "", fmt.Errorf("failed to generate self-signed certificate: %w", err) return nil, "", "", fmt.Errorf("failed to get certificate directory: %w", err)
} }
certFile, keyFile, tmpDir, err := saveCertToTempFiles(certPEM, keyPEM) // Check for existing valid certificates
certFile := filepath.Join(certDir, fmt.Sprintf("%s-cert.pem", host))
keyFile := filepath.Join(certDir, fmt.Sprintf("%s-key.pem", host))
// If valid certificates exist, reuse them
if isCertificateValid(certFile) {
// Verify key file also exists
if _, err := os.Stat(keyFile); err == nil {
tlsConfig := &tls.Config{
MinVersion: tls.VersionTLS12,
}
return tlsConfig, certFile, keyFile, nil
}
}
// Generate new certificates
certPEM, keyPEM, err := generateSelfSignedCert(host)
if err != nil { if err != nil {
return nil, "", "", "", fmt.Errorf("failed to save self-signed certificate: %w", err) return nil, "", "", fmt.Errorf("failed to generate self-signed certificate: %w", err)
}
certFile, keyFile, err = saveCertToFiles(certPEM, keyPEM, host)
if err != nil {
return nil, "", "", fmt.Errorf("failed to save self-signed certificate: %w", err)
} }
tlsConfig := &tls.Config{ tlsConfig := &tls.Config{
MinVersion: tls.VersionTLS12, MinVersion: tls.VersionTLS12,
} }
return tlsConfig, certFile, keyFile, tmpDir, nil return tlsConfig, certFile, keyFile, nil
} }
return nil, "", "", "", nil return nil, "", "", nil
} }