feat(GODT-2374): Import TLS certs via shell

This commit is contained in:
James Houlahan
2023-02-17 14:02:39 +01:00
parent cac0cf35f6
commit 54c013012e
8 changed files with 104 additions and 13 deletions

View File

@ -51,7 +51,9 @@ func WithVault(locations *locations.Locations, fn func(*vault.Vault, bool, bool)
if installed := encVault.GetCertsInstalled(); !installed { if installed := encVault.GetCertsInstalled(); !installed {
logrus.Debug("Installing certificates") logrus.Debug("Installing certificates")
if err := certs.NewInstaller().InstallCert(encVault.GetBridgeTLSCert()); err != nil { certPEM, _ := encVault.GetBridgeTLSCert()
if err := certs.NewInstaller().InstallCert(certPEM); err != nil {
return fmt.Errorf("failed to install certs: %w", err) return fmt.Errorf("failed to install certs: %w", err)
} }

View File

@ -556,7 +556,7 @@ func (bridge *Bridge) onStatusDown(ctx context.Context) {
} }
func loadTLSConfig(vault *vault.Vault) (*tls.Config, error) { func loadTLSConfig(vault *vault.Vault) (*tls.Config, error) {
cert, err := tls.X509KeyPair(vault.GetBridgeTLSCert(), vault.GetBridgeTLSKey()) cert, err := tls.X509KeyPair(vault.GetBridgeTLSCert())
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@ -18,5 +18,9 @@
package bridge package bridge
func (bridge *Bridge) GetBridgeTLSCert() ([]byte, []byte) { func (bridge *Bridge) GetBridgeTLSCert() ([]byte, []byte) {
return bridge.vault.GetBridgeTLSCert(), bridge.vault.GetBridgeTLSKey() return bridge.vault.GetBridgeTLSCert()
}
func (bridge *Bridge) SetBridgeTLSCertPath(certPath, keyPath string) error {
return bridge.vault.SetBridgeTLSCertPath(certPath, keyPath)
} }

View File

@ -135,12 +135,16 @@ func New(bridge *bridge.Bridge, restarter *restarter.Restarter, eventCh <-chan e
fe.AddCmd(configureCmd) fe.AddCmd(configureCmd)
// TLS commands. // TLS commands.
exportTLSCmd := &ishell.Cmd{ fe.AddCmd(&ishell.Cmd{
Name: "export-tls", Name: "export-tls-cert",
Help: "Export the TLS certificate used by the Bridge", Help: "Export the TLS certificate used by the Bridge",
Func: fe.exportTLSCerts, Func: fe.exportTLSCerts,
} })
fe.AddCmd(exportTLSCmd) fe.AddCmd(&ishell.Cmd{
Name: "import-tls-cert",
Help: "Import a TLS certificate to be used by the Bridge",
Func: fe.importTLSCerts,
})
// All mail visibility commands. // All mail visibility commands.
allMailCmd := &ishell.Cmd{ allMailCmd := &ishell.Cmd{

View File

@ -226,6 +226,27 @@ func (f *frontendCLI) exportTLSCerts(c *ishell.Context) {
} }
} }
func (f *frontendCLI) importTLSCerts(c *ishell.Context) {
certPath := f.readStringInAttempts("Enter the path to the cert.pem file", c.ReadLine, f.isFile)
if certPath == "" {
f.printAndLogError(errors.New("failed to get cert path"))
return
}
keyPath := f.readStringInAttempts("Enter the path to the key.pem file", c.ReadLine, f.isFile)
if keyPath == "" {
f.printAndLogError(errors.New("failed to get key path"))
return
}
if err := f.bridge.SetBridgeTLSCertPath(certPath, keyPath); err != nil {
f.printAndLogError(err)
return
}
f.Println("TLS certificate imported. Restart Bridge to use it.")
}
func (f *frontendCLI) isPortFree(port string) bool { func (f *frontendCLI) isPortFree(port string) bool {
port = strings.ReplaceAll(port, ":", "") port = strings.ReplaceAll(port, ":", "")
if port == "" { if port == "" {
@ -252,3 +273,12 @@ func (f *frontendCLI) isCacheLocationUsable(location string) bool {
return stat.IsDir() return stat.IsDir()
} }
func (f *frontendCLI) isFile(location string) bool {
stat, err := os.Stat(location)
if err != nil {
return false
}
return !stat.IsDir()
}

View File

@ -17,12 +17,40 @@
package vault package vault
func (vault *Vault) GetBridgeTLSCert() []byte { import (
return vault.get().Certs.Bridge.Cert "crypto/tls"
"fmt"
"os"
"path/filepath"
"github.com/sirupsen/logrus"
)
// GetBridgeTLSCert returns the PEM-encoded certificate for the bridge.
// If CertPEMPath is set, it will attempt to read the certificate from the file.
// Otherwise, or on read/validation failure, it will return the certificate from the vault.
func (vault *Vault) GetBridgeTLSCert() ([]byte, []byte) {
if certPath, keyPath := vault.get().Certs.CustomCertPath, vault.get().Certs.CustomKeyPath; certPath != "" && keyPath != "" {
if certPEM, keyPEM, err := readPEMCert(certPath, keyPath); err == nil {
return certPEM, keyPEM
}
logrus.Error("Failed to read certificate from file, using default")
}
return vault.get().Certs.Bridge.Cert, vault.get().Certs.Bridge.Key
} }
func (vault *Vault) GetBridgeTLSKey() []byte { // SetBridgeTLSCertPath sets the path to PEM-encoded certificates for the bridge.
return vault.get().Certs.Bridge.Key func (vault *Vault) SetBridgeTLSCertPath(certPath, keyPath string) error {
if _, _, err := readPEMCert(certPath, keyPath); err != nil {
return fmt.Errorf("invalid certificate: %w", err)
}
return vault.mod(func(data *Data) {
data.Certs.CustomCertPath = certPath
data.Certs.CustomKeyPath = keyPath
})
} }
func (vault *Vault) GetCertsInstalled() bool { func (vault *Vault) GetCertsInstalled() bool {
@ -34,3 +62,21 @@ func (vault *Vault) SetCertsInstalled(installed bool) error {
data.Certs.Installed = installed data.Certs.Installed = installed
}) })
} }
func readPEMCert(certPEMPath, keyPEMPath string) ([]byte, []byte, error) {
certPEM, err := os.ReadFile(filepath.Clean(certPEMPath))
if err != nil {
return nil, nil, err
}
keyPEM, err := os.ReadFile(filepath.Clean(keyPEMPath))
if err != nil {
return nil, nil, err
}
if _, err := tls.X509KeyPair(certPEM, keyPEM); err != nil {
return nil, nil, err
}
return certPEM, keyPEM, nil
}

View File

@ -28,8 +28,9 @@ func TestVault_TLSCerts(t *testing.T) {
s := newVault(t) s := newVault(t)
// Check the default bridge TLS certs. // Check the default bridge TLS certs.
require.NotEmpty(t, s.GetBridgeTLSCert()) cert, key := s.GetBridgeTLSCert()
require.NotEmpty(t, s.GetBridgeTLSKey()) require.NotEmpty(t, cert)
require.NotEmpty(t, key)
// Check the certificates are not installed. // Check the certificates are not installed.
require.False(t, s.GetCertsInstalled()) require.False(t, s.GetCertsInstalled())

View File

@ -22,6 +22,10 @@ import "github.com/ProtonMail/proton-bridge/v3/internal/certs"
type Certs struct { type Certs struct {
Bridge Cert Bridge Cert
Installed bool Installed bool
// If non-empty, the path to the PEM-encoded certificate file.
CustomCertPath string
CustomKeyPath string
} }
type Cert struct { type Cert struct {