GODT-1816: Connect Gluon Logs to bridge Logs

Ensure the IMAP commands and SMTP commands are logged to trace channels
with an entry so they are recognizable as before.

internal/bridge/bridge.go

@@ -72,20 +72,27 @@ type Bridge struct {
 
 	// stopCh is used to stop ongoing goroutines when the bridge is closed.
 	stopCh chan struct{}
+
+	logIMAPClientCommands bool
+	logIMAPServerCommands bool
+	logSMTPCommands       bool
 }
 
 // New creates a new bridge.
 func New(
-	apiURL string, // the URL of the API to use
-	locator Locator, // the locator to provide paths to store data
-	vault *vault.Vault, // the bridge's encrypted data store
-	identifier Identifier, // the identifier to keep track of the user agent
-	tlsReporter TLSReporter, // the TLS reporter to report TLS errors
+	apiURL string,                  // the URL of the API to use
+	locator Locator,                // the locator to provide paths to store data
+	vault *vault.Vault,             // the bridge's encrypted data store
+	identifier Identifier,          // the identifier to keep track of the user agent
+	tlsReporter TLSReporter,        // the TLS reporter to report TLS errors
 	roundTripper http.RoundTripper, // the round tripper to use for API requests
-	proxyCtl ProxyController, // the DoH controller
-	autostarter Autostarter, // the autostarter to manage autostart settings
-	updater Updater, // the updater to fetch and install updates
-	curVersion *semver.Version, // the current version of the bridge
+	proxyCtl ProxyController,       // the DoH controller
+	autostarter Autostarter,        // the autostarter to manage autostart settings
+	updater Updater,                // the updater to fetch and install updates
+	curVersion *semver.Version,     // the current version of the bridge
+	logIMAPClientCommands bool,
+	logIMAPServerCommands bool,
+	logSMTPCommands bool,
 ) (*Bridge, error) {
 	if vault.GetProxyAllowed() {
 		proxyCtl.AllowProxy()
@@ -116,7 +123,7 @@ func New(
 		return nil, fmt.Errorf("failed to get Gluon directory: %w", err)
 	}
 
-	imapServer, err := newIMAPServer(gluonDir, curVersion, tlsConfig)
+	imapServer, err := newIMAPServer(gluonDir, curVersion, tlsConfig, logIMAPClientCommands, logIMAPServerCommands)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create IMAP server: %w", err)
 	}
@@ -126,7 +133,7 @@ func New(
 		return nil, fmt.Errorf("failed to create SMTP backend: %w", err)
 	}
 
-	smtpServer, err := newSMTPServer(smtpBackend, tlsConfig)
+	smtpServer, err := newSMTPServer(smtpBackend, tlsConfig, logSMTPCommands)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create SMTP server: %w", err)
 	}
@@ -159,6 +166,10 @@ func New(
 		locator:      locator,
 
 		stopCh: make(chan struct{}),
+
+		logIMAPClientCommands: logIMAPClientCommands,
+		logIMAPServerCommands: logIMAPServerCommands,
+		logSMTPCommands:       logSMTPCommands,
 	}
 
 	api.AddStatusObserver(func(status liteapi.Status) {

internal/bridge/bridge_test.go

@@ -426,6 +426,9 @@ func withBridge(
 		mocks.Autostarter,
 		mocks.Updater,
 		v2_3_0,
+		false,
+		false,
+		false,
 	)
 	require.NoError(t, err)
 

internal/bridge/imap.go

@@ -5,6 +5,8 @@ import (
 	"crypto/tls"
 	"errors"
 	"fmt"
+	"github.com/ProtonMail/proton-bridge/v2/internal/logging"
+	"io"
 	"io/fs"
 	"net"
 	"os"
@@ -111,7 +113,29 @@ func getGluonDir(encVault *vault.Vault) (string, error) {
 	return encVault.GetGluonDir(), nil
 }
 
-func newIMAPServer(gluonDir string, version *semver.Version, tlsConfig *tls.Config) (*gluon.Server, error) {
+func newIMAPServer(gluonDir string, version *semver.Version, tlsConfig *tls.Config, logIMAPCommandsClient, logImapCommandsServer bool) (*gluon.Server, error) {
+	var imapClientLog io.Writer
+	var imapServerLog io.Writer
+
+	if logIMAPCommandsClient || logImapCommandsServer {
+		log := logrus.WithField("protocol", "IMAP")
+		log.Warning("================================================")
+		log.Warning("THIS LOG WILL CONTAIN **DECRYPTED** MESSAGE DATA")
+		log.Warning("================================================")
+	}
+
+	if logIMAPCommandsClient {
+		imapClientLog = logging.NewIMAPLogger()
+	} else {
+		imapClientLog = io.Discard
+	}
+
+	if logImapCommandsServer {
+		imapServerLog = logging.NewIMAPLogger()
+	} else {
+		imapClientLog = io.Discard
+	}
+
 	imapServer, err := gluon.New(
 		gluon.WithTLS(tlsConfig),
 		gluon.WithDataDir(gluonDir),
@@ -124,8 +148,8 @@ func newIMAPServer(gluonDir string, version *semver.Version, tlsConfig *tls.Conf
 			"TODO",
 		),
 		gluon.WithLogger(
-			logrus.StandardLogger().WriterLevel(logrus.TraceLevel),
-			logrus.StandardLogger().WriterLevel(logrus.TraceLevel),
+			imapClientLog,
+			imapServerLog,
 		),
 	)
 	if err != nil {

internal/bridge/settings.go

@@ -112,7 +112,7 @@ func (bridge *Bridge) SetGluonDir(ctx context.Context, newGluonDir string) error
 		return fmt.Errorf("failed to set new gluon dir: %w", err)
 	}
 
-	imapServer, err := newIMAPServer(bridge.vault.GetGluonDir(), bridge.curVersion, bridge.tlsConfig)
+	imapServer, err := newIMAPServer(bridge.vault.GetGluonDir(), bridge.curVersion, bridge.tlsConfig, bridge.logIMAPClientCommands, bridge.logIMAPServerCommands)
 	if err != nil {
 		return fmt.Errorf("failed to create new IMAP server: %w", err)
 	}

internal/bridge/smtp.go

@@ -3,6 +3,7 @@ package bridge
 import (
 	"crypto/tls"
 	"fmt"
+	"github.com/ProtonMail/proton-bridge/v2/internal/logging"
 	"net"
 	"strconv"
 
@@ -48,7 +49,7 @@ func (bridge *Bridge) restartSMTP() error {
 		return err
 	}
 
-	smtpServer, err := newSMTPServer(bridge.smtpBackend, bridge.tlsConfig)
+	smtpServer, err := newSMTPServer(bridge.smtpBackend, bridge.tlsConfig, bridge.logSMTPCommands)
 	if err != nil {
 		return err
 	}
@@ -68,13 +69,22 @@ func (bridge *Bridge) closeSMTP() error {
 	return nil
 }
 
-func newSMTPServer(smtpBackend *smtpBackend, tlsConfig *tls.Config) (*smtp.Server, error) {
+func newSMTPServer(smtpBackend *smtpBackend, tlsConfig *tls.Config, shouldLog bool) (*smtp.Server, error) {
 	smtpServer := smtp.NewServer(smtpBackend)
 
 	smtpServer.TLSConfig = tlsConfig
 	smtpServer.Domain = constants.Host
 	smtpServer.AllowInsecureAuth = true
 	smtpServer.MaxLineLength = 1 << 16
+	smtpServer.ErrorLog = logging.NewSMTPLogger()
+
+	if shouldLog {
+		log := logrus.WithField("protocol", "SMTP")
+		log.Warning("================================================")
+		log.Warning("THIS LOG WILL CONTAIN **DECRYPTED** MESSAGE DATA")
+		log.Warning("================================================")
+		smtpServer.Debug = logging.NewSMTPDebugLogger()
+	}
 
 	smtpServer.EnableAuth(sasl.Login, func(conn *smtp.Conn) sasl.Server {
 		return sasl.NewLoginServer(func(address, password string) error {