mirror of
https://github.com/ProtonMail/proton-bridge.git
synced 2025-12-17 23:56:56 +00:00
GODT-1187: Remove IMAP/SMTP blocking when no internet.
This commit is contained in:
Jakub
117
internal/serverutil/controller.go
Normal file
117
internal/serverutil/controller.go
Normal file
@ -0,0 +1,117 @@
|
||||
// Copyright (c) 2021 Proton Technologies AG
|
||||
//
|
||||
// This file is part of ProtonMail Bridge.
|
||||
//
|
||||
// ProtonMail Bridge is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// ProtonMail Bridge is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
package serverutil
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"fmt"
|
||||
"net"
|
||||
|
||||
"github.com/ProtonMail/proton-bridge/internal/events"
|
||||
"github.com/ProtonMail/proton-bridge/pkg/listener"
|
||||
"github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
// Controller will make sure that server is listening and serving and if needed
|
||||
// users are disconnected.
|
||||
type Controller interface {
|
||||
ListenAndServe()
|
||||
Close()
|
||||
}
|
||||
|
||||
// NewController return simple server controller.
|
||||
func NewController(s Server, l listener.Listener) Controller {
|
||||
log := logrus.WithField("pkg", "serverutil").WithField("protocol", s.Protocol())
|
||||
c := &controller{
|
||||
server: s,
|
||||
signals: l,
|
||||
log: log,
|
||||
closeDisconnectUsers: make(chan void),
|
||||
}
|
||||
|
||||
if s.DebugServer() {
|
||||
fmt.Println("THE LOG WILL CONTAIN **DECRYPTED** MESSAGE DATA")
|
||||
log.Warning("================================================")
|
||||
log.Warning("THIS LOG WILL CONTAIN **DECRYPTED** MESSAGE DATA")
|
||||
log.Warning("================================================")
|
||||
}
|
||||
|
||||
return c
|
||||
}
|
||||
|
||||
type void struct{}
|
||||
|
||||
type controller struct {
|
||||
server Server
|
||||
signals listener.Listener
|
||||
log *logrus.Entry
|
||||
|
||||
closeDisconnectUsers chan void
|
||||
}
|
||||
|
||||
func (c *controller) Close() {
|
||||
c.closeDisconnectUsers <- void{}
|
||||
if err := c.server.StopServe(); err != nil {
|
||||
c.log.WithError(err).Error("Issue when closing server")
|
||||
}
|
||||
}
|
||||
|
||||
// ListenAndServe starts the server and keeps it on based on internet
|
||||
// availability. It also monitors and disconnect users if requested.
|
||||
func (c *controller) ListenAndServe() {
|
||||
go monitorDisconnectedUsers(c.server, c.signals, c.closeDisconnectUsers)
|
||||
|
||||
defer c.server.HandlePanic()
|
||||
|
||||
l := c.log.WithField("useSSL", c.server.UseSSL()).
|
||||
WithField("address", c.server.Address())
|
||||
|
||||
var listener net.Listener
|
||||
var err error
|
||||
|
||||
if c.server.UseSSL() {
|
||||
listener, err = tls.Listen("tcp", c.server.Address(), c.server.TLSConfig())
|
||||
} else {
|
||||
listener, err = net.Listen("tcp", c.server.Address())
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
l.WithError(err).Error("Cannot start listner.")
|
||||
c.signals.Emit(events.ErrorEvent, string(c.server.Protocol())+" failed: "+err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
// When starting the Bridge, we don't want to retry to notify user
|
||||
// quickly about the issue. Very probably retry will not help anyway.
|
||||
l.Info("Starting server")
|
||||
err = c.server.Serve(&connListener{listener, c.server})
|
||||
l.WithError(err).Debug("GoSMTP not serving")
|
||||
}
|
||||
|
||||
func monitorDisconnectedUsers(s Server, l listener.Listener, done <-chan void) {
|
||||
ch := make(chan string)
|
||||
l.Add(events.CloseConnectionEvent, ch)
|
||||
for {
|
||||
select {
|
||||
case <-done:
|
||||
return
|
||||
case address := <-ch:
|
||||
s.DisconnectUser(address)
|
||||
}
|
||||
}
|
||||
}
|
||||
39
internal/serverutil/error_logger.go
Normal file
39
internal/serverutil/error_logger.go
Normal file
@ -0,0 +1,39 @@
|
||||
// Copyright (c) 2021 Proton Technologies AG
|
||||
//
|
||||
// This file is part of ProtonMail Bridge.
|
||||
//
|
||||
// ProtonMail Bridge is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// ProtonMail Bridge is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
package serverutil
|
||||
|
||||
import (
|
||||
"github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
// ServerErrorLogger implements go-imap/logger interface.
|
||||
type ServerErrorLogger struct {
|
||||
l *logrus.Entry
|
||||
}
|
||||
|
||||
func NewServerErrorLogger(protocol Protocol) *ServerErrorLogger {
|
||||
return &ServerErrorLogger{l: logrus.WithField("protocol", protocol)}
|
||||
}
|
||||
|
||||
func (s *ServerErrorLogger) Printf(format string, args ...interface{}) {
|
||||
s.l.Errorf(format, args...)
|
||||
}
|
||||
|
||||
func (s *ServerErrorLogger) Println(args ...interface{}) {
|
||||
s.l.Errorln(args...)
|
||||
}
|
||||
59
internal/serverutil/listener.go
Normal file
59
internal/serverutil/listener.go
Normal file
@ -0,0 +1,59 @@
|
||||
// Copyright (c) 2021 Proton Technologies AG
|
||||
//
|
||||
// This file is part of ProtonMail Bridge.
|
||||
//
|
||||
// ProtonMail Bridge is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// ProtonMail Bridge is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
package serverutil
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net"
|
||||
|
||||
"github.com/sirupsen/logrus"
|
||||
)
|
||||
|
||||
// connListener sets debug loggers on server containing fields with local
|
||||
// and remote addresses right after new connection is accepted.
|
||||
type connListener struct {
|
||||
net.Listener
|
||||
|
||||
server Server
|
||||
}
|
||||
|
||||
func (l *connListener) Accept() (net.Conn, error) {
|
||||
conn, err := l.Listener.Accept()
|
||||
|
||||
if err == nil && (l.server.DebugServer() || l.server.DebugClient()) {
|
||||
debugLog := logrus.WithField("pkg", l.server.Protocol())
|
||||
if addr := conn.LocalAddr(); addr != nil {
|
||||
debugLog = debugLog.WithField("loc", addr.String())
|
||||
}
|
||||
if addr := conn.RemoteAddr(); addr != nil {
|
||||
debugLog = debugLog.WithField("rem", addr.String())
|
||||
}
|
||||
|
||||
var localDebug, remoteDebug io.Writer
|
||||
if l.server.DebugServer() {
|
||||
localDebug = debugLog.WithField("comm", "server").WriterLevel(logrus.DebugLevel)
|
||||
}
|
||||
if l.server.DebugClient() {
|
||||
remoteDebug = debugLog.WithField("comm", "client").WriterLevel(logrus.DebugLevel)
|
||||
}
|
||||
|
||||
l.server.SetLoggers(localDebug, remoteDebug)
|
||||
}
|
||||
|
||||
return conn, err
|
||||
}
|
||||
26
internal/serverutil/protocol.go
Normal file
26
internal/serverutil/protocol.go
Normal file
@ -0,0 +1,26 @@
|
||||
// Copyright (c) 2021 Proton Technologies AG
|
||||
//
|
||||
// This file is part of ProtonMail Bridge.
|
||||
//
|
||||
// ProtonMail Bridge is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// ProtonMail Bridge is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
package serverutil
|
||||
|
||||
type Protocol string
|
||||
|
||||
const (
|
||||
HTTP = Protocol("HTTP")
|
||||
IMAP = Protocol("IMAP")
|
||||
SMTP = Protocol("SMTP")
|
||||
)
|
||||
@ -18,32 +18,24 @@
|
||||
package serverutil
|
||||
|
||||
import (
|
||||
"time"
|
||||
|
||||
"github.com/ProtonMail/proton-bridge/internal/events"
|
||||
"github.com/ProtonMail/proton-bridge/pkg/listener"
|
||||
"crypto/tls"
|
||||
"io"
|
||||
"net"
|
||||
)
|
||||
|
||||
// Server which can handle disconnected users and lost internet connection.
|
||||
// Server can handle disconnected users.
|
||||
type Server interface {
|
||||
Protocol() Protocol
|
||||
UseSSL() bool
|
||||
Address() string
|
||||
TLSConfig() *tls.Config
|
||||
|
||||
DebugServer() bool
|
||||
DebugClient() bool
|
||||
SetLoggers(localDebug, remoteDebug io.Writer)
|
||||
|
||||
HandlePanic()
|
||||
DisconnectUser(string)
|
||||
ListenRetryAndServe(int, time.Duration)
|
||||
}
|
||||
|
||||
func monitorDisconnectedUsers(s Server, l listener.Listener) {
|
||||
ch := make(chan string)
|
||||
l.Add(events.CloseConnectionEvent, ch)
|
||||
for address := range ch {
|
||||
s.DisconnectUser(address)
|
||||
}
|
||||
}
|
||||
|
||||
// ListenAndServe starts the server and keeps it on based on internet
|
||||
// availability. It also monitors and disconnect users if requested.
|
||||
func ListenAndServe(s Server, l listener.Listener) {
|
||||
go monitorDisconnectedUsers(s, l)
|
||||
|
||||
// When starting the Bridge, we don't want to retry to notify user
|
||||
// quickly about the issue. Very probably retry will not help anyway.
|
||||
s.ListenRetryAndServe(0, 0)
|
||||
Serve(net.Listener) error
|
||||
StopServe() error
|
||||
}
|
||||
|
||||
153
internal/serverutil/test/controller_test.go
Normal file
153
internal/serverutil/test/controller_test.go
Normal file
@ -0,0 +1,153 @@
|
||||
// Copyright (c) 2021 Proton Technologies AG
|
||||
//
|
||||
// This file is part of ProtonMail Bridge.
|
||||
//
|
||||
// ProtonMail Bridge is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// ProtonMail Bridge is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
package test
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/ProtonMail/proton-bridge/internal/events"
|
||||
"github.com/ProtonMail/proton-bridge/internal/serverutil"
|
||||
"github.com/ProtonMail/proton-bridge/pkg/listener"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func setup(t *testing.T) (*require.Assertions, *testServer, listener.Listener, serverutil.Controller) {
|
||||
r := require.New(t)
|
||||
s := newTestServer()
|
||||
l := listener.New()
|
||||
c := serverutil.NewController(s, l)
|
||||
|
||||
return r, s, l, c
|
||||
}
|
||||
|
||||
func TestControllerListernServeClose(t *testing.T) {
|
||||
r, s, l, c := setup(t)
|
||||
|
||||
errorCh := l.ProvideChannel(events.ErrorEvent)
|
||||
|
||||
r.True(s.portIsFree())
|
||||
go c.ListenAndServe()
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
|
||||
r.NoError(s.ping())
|
||||
|
||||
r.Nil(s.localDebug)
|
||||
r.Nil(s.remoteDebug)
|
||||
|
||||
c.Close()
|
||||
r.Eventually(s.portIsFree, time.Second, 50*time.Millisecond)
|
||||
|
||||
select {
|
||||
case msg := <-errorCh:
|
||||
r.Fail("Expected no error but have %q", msg)
|
||||
case <-time.Tick(100 * time.Millisecond):
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
func TestControllerFailOnBusyPort(t *testing.T) {
|
||||
r, s, l, c := setup(t)
|
||||
|
||||
ocupator := http.Server{Addr: s.Address()}
|
||||
defer ocupator.Close() //nolint[errcheck]
|
||||
|
||||
go ocupator.ListenAndServe() //nolint[errcheck]
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
|
||||
errorCh := l.ProvideChannel(events.ErrorEvent)
|
||||
go c.ListenAndServe()
|
||||
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
|
||||
select {
|
||||
case <-errorCh:
|
||||
break
|
||||
case <-time.Tick(time.Second):
|
||||
r.Fail("Expected error but have none.")
|
||||
}
|
||||
}
|
||||
|
||||
func TestControllerCallDisconnectUser(t *testing.T) {
|
||||
r, s, l, c := setup(t)
|
||||
|
||||
go c.ListenAndServe()
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
r.NoError(s.ping())
|
||||
|
||||
l.Emit(events.CloseConnectionEvent, "")
|
||||
r.Eventually(func() bool { return s.calledDisconnected == 1 }, time.Second, 50*time.Millisecond)
|
||||
|
||||
c.Close()
|
||||
r.Eventually(s.portIsFree, time.Second, 50*time.Millisecond)
|
||||
|
||||
l.Emit(events.CloseConnectionEvent, "")
|
||||
r.Equal(1, s.calledDisconnected)
|
||||
}
|
||||
|
||||
func TestDebugClient(t *testing.T) {
|
||||
r, s, _, c := setup(t)
|
||||
|
||||
s.debugServer = false
|
||||
s.debugClient = true
|
||||
|
||||
go c.ListenAndServe()
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
r.NoError(s.ping())
|
||||
|
||||
r.Nil(s.localDebug)
|
||||
r.NotNil(s.remoteDebug)
|
||||
|
||||
c.Close()
|
||||
r.Eventually(s.portIsFree, time.Second, 50*time.Millisecond)
|
||||
}
|
||||
|
||||
func TestDebugServer(t *testing.T) {
|
||||
r, s, _, c := setup(t)
|
||||
|
||||
s.debugServer = true
|
||||
s.debugClient = false
|
||||
|
||||
go c.ListenAndServe()
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
r.NoError(s.ping())
|
||||
|
||||
r.NotNil(s.localDebug)
|
||||
r.Nil(s.remoteDebug)
|
||||
|
||||
c.Close()
|
||||
r.Eventually(s.portIsFree, time.Second, 50*time.Millisecond)
|
||||
}
|
||||
|
||||
func TestDebugBoth(t *testing.T) {
|
||||
r, s, _, c := setup(t)
|
||||
|
||||
s.debugServer = true
|
||||
s.debugClient = true
|
||||
|
||||
go c.ListenAndServe()
|
||||
r.Eventually(s.portIsOccupied, time.Second, 50*time.Millisecond)
|
||||
r.NoError(s.ping())
|
||||
|
||||
r.NotNil(s.localDebug)
|
||||
r.NotNil(s.remoteDebug)
|
||||
|
||||
c.Close()
|
||||
r.Eventually(s.portIsFree, time.Second, 50*time.Millisecond)
|
||||
}
|
||||
88
internal/serverutil/test/server.go
Normal file
88
internal/serverutil/test/server.go
Normal file
@ -0,0 +1,88 @@
|
||||
// Copyright (c) 2021 Proton Technologies AG
|
||||
//
|
||||
// This file is part of ProtonMail Bridge.
|
||||
//
|
||||
// ProtonMail Bridge is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// ProtonMail Bridge is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
package test
|
||||
|
||||
import (
|
||||
"crypto/tls"
|
||||
"fmt"
|
||||
"io"
|
||||
"net"
|
||||
"net/http"
|
||||
|
||||
"github.com/ProtonMail/proton-bridge/internal/serverutil"
|
||||
"github.com/ProtonMail/proton-bridge/pkg/ports"
|
||||
)
|
||||
|
||||
func newTestServer() *testServer {
|
||||
return &testServer{port: 11188}
|
||||
}
|
||||
|
||||
type testServer struct {
|
||||
http http.Server
|
||||
|
||||
useSSL,
|
||||
debugServer,
|
||||
debugClient bool
|
||||
calledDisconnected int
|
||||
|
||||
port int
|
||||
tls *tls.Config
|
||||
|
||||
localDebug, remoteDebug io.Writer
|
||||
}
|
||||
|
||||
func (*testServer) Protocol() serverutil.Protocol { return serverutil.HTTP }
|
||||
func (s *testServer) UseSSL() bool { return s.useSSL }
|
||||
func (s *testServer) Address() string { return fmt.Sprintf("127.0.0.1:%d", s.port) }
|
||||
func (s *testServer) TLSConfig() *tls.Config { return s.tls }
|
||||
func (s *testServer) HandlePanic() {}
|
||||
|
||||
func (s *testServer) DebugServer() bool { return s.debugServer }
|
||||
func (s *testServer) DebugClient() bool { return s.debugClient }
|
||||
func (s *testServer) SetLoggers(localDebug, remoteDebug io.Writer) {
|
||||
s.localDebug = localDebug
|
||||
s.remoteDebug = remoteDebug
|
||||
}
|
||||
|
||||
func (s *testServer) DisconnectUser(string) {
|
||||
s.calledDisconnected++
|
||||
}
|
||||
|
||||
func (s *testServer) Serve(l net.Listener) error {
|
||||
return s.http.Serve(l)
|
||||
}
|
||||
|
||||
func (s *testServer) StopServe() error { return s.http.Close() }
|
||||
|
||||
func (s *testServer) portIsFree() bool {
|
||||
return ports.IsPortFree(s.port)
|
||||
}
|
||||
|
||||
func (s *testServer) portIsOccupied() bool {
|
||||
return !ports.IsPortFree(s.port)
|
||||
}
|
||||
|
||||
func (s *testServer) ping() error {
|
||||
client := &http.Client{}
|
||||
resp, err := client.Get("http://" + s.Address() + "/ping")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return resp.Body.Close()
|
||||
}
|
||||
Reference in New Issue
Block a user