zishuo/protoplex
1
0
Fork 0
mirror of https://github.com/SapphicCode/protoplex.git synced 2025-09-26 19:31:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refactor logging to use zerolog (#7)

Browse Source
This commit is contained in:
Cassandra
2019-08-29 18:29:13 +02:00
committed by GitHub
parent cf600c84ae
commit 9475e49da8
4 changed files with 44 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
cmd/protoplex/protoplex.go
View File

@@ -2,17 +2,19 @@ package main
import (
"flag"
"os"
"github.com/Pandentia/protoplex/protoplex"
"github.com/Pandentia/protoplex/protoplex/protocols"
"github.com/juju/loggo"
"github.com/rs/zerolog"
)
func main() {
logger := loggo.GetLogger("protoplex")
logger := zerolog.New(os.Stdout).With().Timestamp().Logger()
bind := flag.String("bind", "0.0.0.0:8443", "The address to bind to")
verbose := flag.Bool("verbose", false, "Whether to be verbose")
pretty := flag.Bool("pretty", false, "Whether to enable pretty printing")
ssh := flag.String("ssh", "", "The SSH server address")
tls := flag.String("tls", "", "The TLS/HTTPS server address")
@@ -24,10 +26,14 @@ func main() {
flag.Parse()
if *pretty {
logger = logger.Output(zerolog.ConsoleWriter{Out: os.Stderr})
}
if *verbose {
logger.SetLogLevel(loggo.DEBUG)
logger = logger.Level(zerolog.DebugLevel)
} else {
logger.SetLogLevel(loggo.INFO)
logger = logger.Level(zerolog.InfoLevel)
}
p := make([]*protocols.Protocol, 0, 7)
@@ -58,5 +64,5 @@ func main() {
p = append(p, protocols.NewHTTPProtocol(*http))
}
protoplex.RunServer(*bind, p)
protoplex.RunServer(*bind, p, logger)
}

2
go.mod
View File

@@ -2,4 +2,4 @@ module github.com/Pandentia/protoplex
go 1.12
require github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8
require github.com/rs/zerolog v1.15.0

14
go.sum
View File

@@ -1,2 +1,12 @@
github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8 h1:UUHMLvzt/31azWTN/ifGWef4WUqvXk0iRqdhdy/2uzI=
github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8/go.mod h1:vgyd7OREkbtVEN/8IXZe5Ooef3LQePvuBm9UWj6ZL8U=
github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ=
github.com/rs/zerolog v1.15.0 h1:uPRuwkWF4J6fGsJ2R0Gn2jB1EQiav9k3S6CSdygQJXY=
github.com/rs/zerolog v1.15.0/go.mod h1:xYTKnLHcpfU2225ny5qZjxnj9NvkumZYjJHlAThCjNc=
github.com/zenazn/goji v0.9.0/go.mod h1:7S9M489iMyHBNxwZnk9/EHS098H4/F6TATF2mIxtB1Q=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=

40
protoplex/multiplexer.go
View File

@@ -6,45 +6,44 @@ import (
"os"
"time"
"github.com/rs/zerolog"
"github.com/Pandentia/protoplex/protoplex/protocols"
"github.com/juju/loggo"
)
// RunServer runs protoplex
func RunServer(bind string, p []*protocols.Protocol) {
logger := loggo.GetLogger("protoplex.listener")
func RunServer(bind string, p []*protocols.Protocol, logger zerolog.Logger) {
logger = logger.With().Str("module", "listener").Logger()
if len(p) == 0 {
logger.Warningf("No protocols defined.\n")
logger.Warn().Msg("No protocols defined.")
} else {
logger.Infof("Protocol chain:\n")
logger.Info().Msg("Protocol chain:")
for _, proto := range p {
logger.Infof("- %s @ %s\n", proto.Name, proto.Target)
logger.Info().Str("protocol", proto.Name).Str("target", proto.Target).Msgf("- %s @ %s", proto.Name, proto.Target)
}
}
listener, err := net.Listen("tcp", bind)
if err != nil {
logger.Criticalf("Unable to create listener: %s\n", err)
logger.Fatal().Str("bind", bind).Err(err).Msg("Unable to create listener.")
os.Exit(1)
}
defer listener.Close()
logger.Infof("Listening at %s...\n", listener.Addr())
logger.Info().Str("bind", listener.Addr().String()).Msg("Listening...")
for {
conn, err := listener.Accept()
if err != nil {
logger.Debugf("Error while accepting connection: %s\n", err)
logger.Debug().Err(err).Msg("Error while accepting connection.")
}
logger.Debugf("%s: Connection accepted.\n", conn.RemoteAddr())
go ConnectionHandler(conn, p)
go ConnectionHandler(conn, p,
logger.With().Str("module", "handler").Str("ip", conn.RemoteAddr().String()).Logger())
}
}
// ConnectionHandler connects a net.Conn with a proxy target given a list of protocols
func ConnectionHandler(conn net.Conn, p []*protocols.Protocol) {
func ConnectionHandler(conn net.Conn, p []*protocols.Protocol, logger zerolog.Logger) {
defer conn.Close() // the connection must close after this goroutine exits
connectionID := conn.RemoteAddr().String()
logger := loggo.GetLogger("protoplex.connection")
identifyBuffer := make([]byte, 1024) // at max 1KB buffer to identify payload
@@ -52,7 +51,7 @@ func ConnectionHandler(conn net.Conn, p []*protocols.Protocol) {
_ = conn.SetReadDeadline(time.Now().Add(15 * time.Second)) // 15-second timeout to identify
n, err := conn.Read(identifyBuffer)
if err != nil {
logger.Debugf("%s: Identify read error (%s). Connection closed.\n", connectionID, err)
logger.Debug().Err(err).Msg("Identify read error. Connection closed.")
return
}
_ = conn.SetReadDeadline(time.Time{}) // reset our timeout
@@ -60,21 +59,22 @@ func ConnectionHandler(conn net.Conn, p []*protocols.Protocol) {
// determine the protocol
protocol := DetermineProtocol(identifyBuffer[:n], p)
if protocol == nil { // unsuccessful protocol identify, close and forget
logger.Debugf("%s: Protocol unrecognized. Connection closed.\n", connectionID)
logger.Debug().Msg("Protocol unrecognized. Connection closed.")
return
}
logger.Debugf("%s: Recognized protocol %s.\n", connectionID, protocol.Name)
logger = logger.With().Str("protocol", protocol.Name).Str("target", protocol.Target).Logger()
logger.Debug().Msg("Protocol recognized.")
// establish our connection with the target
targetConn, err := net.Dial("tcp", protocol.Target)
if err != nil {
logger.Debugf("%s: %s error (%s). Connection closed.\n", connectionID, protocol.Target, err)
logger.Debug().Err(err).Msg("Remote connection unsuccessful.")
return // we were unable to establish the connection with the proxy target
}
defer targetConn.Close()
_, err = targetConn.Write(identifyBuffer[:n]) // tell them everything they just told us
if err != nil {
logger.Debugf("%s: %s error (%s). Connection closed.\n", connectionID, protocol.Target, err)
logger.Debug().Err(err).Msg("Remote disconnected us during identify.")
return // remote rejected us?? okay.
}
@@ -85,7 +85,7 @@ func ConnectionHandler(conn net.Conn, p []*protocols.Protocol) {
// wait for any connection to close
<-closed
logger.Debugf("%s: Connection closed.\n", connectionID)
logger.Debug().Msg("Connection closed.")
}
// DetermineProtocol determines a Protocol based on a given handshake