fixed proxy cmdline parameters and logs

global: make the whole package go mod ready

README.md

@@ -3,7 +3,7 @@ An RFB proxy, written in go that can save and replay FBS files
 * Supports all modern encodings & most useful pseudo-encodings
 * Supports multiple VNC client connections & multi servers (chosen by sessionId)
 * Supports being a "websockify" proxy (for web clients like NoVnc)
-* Produces FBS files compatible with tightvnc player (while using tight's default 3Byte color format)
+* Produces FBS files compatible with [tightvnc's rfb player](https://www.tightvnc.com/rfbplayer.php) (while using tight's default 3Byte color format)
 * Can also be used as:
     * A screen recorder vnc-client
     * A replay server to show fbs recordings to connecting clients 
@@ -23,7 +23,7 @@ An RFB proxy, written in go that can save and replay FBS files
 * player - a toy player that will replay a given fbs file to all incoming connections
 
 ## Usage:
-    recorder -recDir=./recording.rbs -targHost=192.168.0.100 -targPort=5903 -targPass=@@@@@
+    recorder -recFile=./recording.rbs -targHost=192.168.0.100 -targPort=5903 -targPass=@@@@@
     player -fbsFile=./myrec.fbs -tcpPort=5905
     proxy -recDir=./recordings/ -targHost=192.168.0.100 -targPort=5903 -targPass=@@@@@ -tcpPort=5903 -wsPort=5905 -vncPass=@!@!@!
 

build.sh

@@ -2,7 +2,7 @@
 sum="sha1sum"
 
 # VERSION=`date -u +%Y%m%d`
-VERSION="v1.02"
+VERSION="v1.11"
 LDFLAGS="-X main.VERSION=$VERSION -s -w"
 GCFLAGS=""
 

client/client-conn.go

@@ -7,8 +7,8 @@ import (
 	"io"
 	"net"
 	"unicode"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 // A ServerMessage implements a message sent from the server to the client.

client/pixel-format.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 func readPixelFormat(r io.Reader, result *common.PixelFormat) error {

client/server-messages.go

@@ -6,9 +6,9 @@ import (
 	"fmt"
 	"io"
 	"strings"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/encodings"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 // MsgFramebufferUpdate consists of a sequence of rectangles of

client/write-to.go

@@ -2,8 +2,8 @@ package client
 
 import (
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 type WriteTo struct {

common/rfb-reader-helper.go

@@ -5,7 +5,7 @@ import (
 	"encoding/binary"
 	"errors"
 	"io"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 var TightMinToCompress = 12

encodings/enc-copy-rect.go

@@ -3,7 +3,7 @@ package encodings
 import (
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type CopyRectEncoding struct {

encodings/enc-corre.go

@@ -3,7 +3,7 @@ package encodings
 import (
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type CoRREEncoding struct {

encodings/enc-cursor-pseudo.go

@@ -3,7 +3,7 @@ package encodings
 import (
 	"io"
 	"math"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type EncCursorPseudo struct {

encodings/enc-hextile.go

@@ -2,8 +2,8 @@ package encodings
 
 import (
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 const (

encodings/enc-led-state.go

@@ -2,8 +2,8 @@ package encodings
 
 import (
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 type EncLedStatePseudo struct {

encodings/enc-pseudo.go

@@ -2,7 +2,7 @@ package encodings
 
 import (
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type PseudoEncoding struct {

encodings/enc-raw.go

@@ -3,7 +3,7 @@ package encodings
 import (
 	"bytes"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 // RawEncoding is raw pixel data sent by the server.

encodings/enc-rre.go

@@ -3,7 +3,7 @@ package encodings
 import (
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type RREEncoding struct {

encodings/enc-tight.go

@@ -4,8 +4,8 @@ import (
 	"bytes"
 	"errors"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 var TightMinToCompress int = 12

encodings/enc-tightpng.go

@@ -3,8 +3,8 @@ package encodings
 import (
 	"fmt"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 type TightPngEncoding struct {

encodings/enc-zlib.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type ZLibEncoding struct {

encodings/enc-zrle.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type ZRLEEncoding struct {

go.mod

@@ -0,0 +1,3 @@
+module github.com/amitbet/vncproxy
+
+require golang.org/x/net v0.0.0-20181129055619-fae4c4e3ad76

go.sum

@@ -0,0 +1,2 @@
+golang.org/x/net v0.0.0-20181129055619-fae4c4e3ad76 h1:xx5MUFyRQRbPk6VjWjIE1epE/K5AoDD8QUN116NCy8k=
+golang.org/x/net v0.0.0-20181129055619-fae4c4e3ad76/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=

player/cmd/main.go

@@ -4,11 +4,11 @@ import (
 	"flag"
 	"fmt"
 	"os"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/encodings"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
-	"vncproxy/player"
+	"github.com/amitbet/vncproxy/player"
-	"vncproxy/server"
+	"github.com/amitbet/vncproxy/server"
 )
 
 func main() {

player/fbs-play-listener.go

@@ -5,10 +5,10 @@ import (
 
 	"io"
 	"time"
-	"vncproxy/client"
+	"github.com/amitbet/vncproxy/client"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
-	"vncproxy/server"
+	"github.com/amitbet/vncproxy/server"
 )
 
 type VncStreamFileReader interface {

player/fbs-reader.go

@@ -5,9 +5,9 @@ import (
 	"encoding/binary"
 	"io"
 	"os"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/encodings"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 type FbsReader struct {

player/player_test.go

@@ -3,10 +3,10 @@ package player
 import (
 	"testing"
 	"time"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/encodings"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
-	"vncproxy/server"
+	"github.com/amitbet/vncproxy/server"
 )
 
 func TestServer(t *testing.T) {

proxy/cmd/main.go

@@ -1,9 +1,13 @@
 package main
 
-import "vncproxy/proxy"
+import (
-import "flag"
+	"flag"
-import "vncproxy/logger"
+	"os"
-import "os"
+	"path/filepath"
+
+	"github.com/amitbet/vncproxy/logger"
+	vncproxy "github.com/amitbet/vncproxy/proxy"
+)
 
 func main() {
 	//create default session if required
@@ -11,8 +15,9 @@ func main() {
 	var wsPort = flag.String("wsPort", "", "websocket port")
 	var vncPass = flag.String("vncPass", "", "password on incoming vnc connections to the proxy, defaults to no password")
 	var recordDir = flag.String("recDir", "", "path to save FBS recordings WILL NOT RECORD if not defined.")
-	var targetVncPort = flag.String("targPort", "", "target vnc server port")
+	var targetVnc = flag.String("target", "", "target vnc server (host:port or /path/to/unix.socket)")
-	var targetVncHost = flag.String("targHost", "", "target vnc server host")
+	var targetVncPort = flag.String("targPort", "", "target vnc server port (deprecated, use -target)")
+	var targetVncHost = flag.String("targHost", "", "target vnc server host (deprecated, use -target)")
 	var targetVncPass = flag.String("targPass", "", "target vnc password")
 	var logLevel = flag.String("logLevel", "info", "change logging level")
 
@@ -25,8 +30,8 @@ func main() {
 		os.Exit(1)
 	}
 
-	if *targetVncPort == "" {
+	if *targetVnc == "" && *targetVncPort == "" {
-		logger.Error("no target vnc server port defined")
+		logger.Error("no target vnc server host/port or socket defined")
 		flag.Usage()
 		os.Exit(1)
 	}
@@ -34,30 +39,42 @@ func main() {
 	if *vncPass == "" {
 		logger.Warn("proxy will have no password")
 	}
-	if *recordDir == "" {
-		logger.Warn("FBS recording is turned off")
-	}
 
-	tcpUrl := ""
+	tcpURL := ""
 	if *tcpPort != "" {
-		tcpUrl = ":" + string(*tcpPort)
+		tcpURL = ":" + string(*tcpPort)
 	}
-
+	wsURL := ""
-	proxy := &proxy.VncProxy{
+	if *wsPort != "" {
-		WsListeningUrl:   "http://0.0.0.0:" + string(*wsPort) + "/", // empty = not listening on ws
+		wsURL = "http://0.0.0.0:" + string(*wsPort) + "/"
-		RecordingDir:     *recordDir,                                //"/Users/amitbet/vncRec",                     // empty = no recording
+	}
-		TcpListeningUrl:  tcpUrl,
+	proxy := &vncproxy.VncProxy{
+		WsListeningURL:   wsURL, // empty = not listening on ws
+		TCPListeningURL:  tcpURL,
 		ProxyVncPassword: *vncPass, //empty = no auth
-		SingleSession: &proxy.VncSession{
+		SingleSession: &vncproxy.VncSession{
+			Target:         *targetVnc,
 			TargetHostname: *targetVncHost,
 			TargetPort:     *targetVncPort,
 			TargetPassword: *targetVncPass, //"vncPass",
 			ID:             "dummySession",
-			Status:         proxy.SessionStatusInit,
+			Status:         vncproxy.SessionStatusInit,
-			Type:           proxy.SessionTypeRecordingProxy,
+			Type:           vncproxy.SessionTypeProxyPass,
 		}, // to be used when not using sessions
 		UsingSessions: false, //false = single session - defined in the var above
 	}
 
+	if *recordDir != "" {
+		fullPath, err := filepath.Abs(*recordDir)
+		if err != nil {
+			logger.Error("bad recording path: ", err)
+		}
+		logger.Info("FBS recording is turned on, writing to dir: ", fullPath)
+		proxy.RecordingDir = fullPath
+		proxy.SingleSession.Type = vncproxy.SessionTypeRecordingProxy
+	} else {
+		logger.Info("FBS recording is turned off")
+	}
+
 	proxy.StartListening()
 }

proxy/message-listeners.go

@@ -1,10 +1,10 @@
 package proxy
 
 import (
-	"vncproxy/client"
+	"github.com/amitbet/vncproxy/client"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
-	"vncproxy/server"
+	"github.com/amitbet/vncproxy/server"
 )
 
 type ClientUpdater struct {

proxy/proxy.go

@@ -5,18 +5,19 @@ import (
 	"path"
 	"strconv"
 	"time"
-	"vncproxy/client"
+
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/client"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/encodings"
-	"vncproxy/player"
+	"github.com/amitbet/vncproxy/logger"
-	listeners "vncproxy/recorder"
+	"github.com/amitbet/vncproxy/player"
-	"vncproxy/server"
+	listeners "github.com/amitbet/vncproxy/recorder"
+	"github.com/amitbet/vncproxy/server"
 )
 
 type VncProxy struct {
-	TcpListeningUrl  string      // empty = not listening on tcp
+	TCPListeningURL  string      // empty = not listening on tcp
-	WsListeningUrl   string      // empty = not listening on ws
+	WsListeningURL   string      // empty = not listening on ws
 	RecordingDir     string      // empty = no recording
 	ProxyVncPassword string      //empty = no auth
 	SingleSession    *VncSession // to be used when not using sessions
@@ -24,8 +25,17 @@ type VncProxy struct {
 	sessionManager   *SessionManager
 }
 
-func (vp *VncProxy) createClientConnection(targetServerUrl string, vncPass string) (*client.ClientConn, error) {
+func (vp *VncProxy) createClientConnection(target string, vncPass string) (*client.ClientConn, error) {
-	nc, err := net.Dial("tcp", targetServerUrl)
+	var (
+		nc  net.Conn
+		err error
+	)
+
+	if target[0] == '/' {
+		nc, err = net.Dial("unix", target)
+	} else {
+		nc, err = net.Dial("tcp", target)
+	}
 
 	if err != nil {
 		logger.Errorf("error connecting to vnc server: %s", err)
@@ -85,7 +95,12 @@ func (vp *VncProxy) newServerConnHandler(cfg *server.ServerConfig, sconn *server
 
 	session.Status = SessionStatusInit
 	if session.Type == SessionTypeProxyPass || session.Type == SessionTypeRecordingProxy {
-		cconn, err := vp.createClientConnection(session.TargetHostname+":"+session.TargetPort, session.TargetPassword)
+		target := session.Target
+		if session.TargetHostname != "" && session.TargetPort != "" {
+			target = session.TargetHostname + ":" + session.TargetPort
+		}
+
+		cconn, err := vp.createClientConnection(target, session.TargetPassword)
 		if err != nil {
 			session.Status = SessionStatusError
 			logger.Errorf("Proxy.newServerConnHandler error creating connection: %s", err)
@@ -171,19 +186,19 @@ func (vp *VncProxy) StartListening() {
 		UseDummySession:  !vp.UsingSessions,
 	}
 
-	if vp.TcpListeningUrl != "" && vp.WsListeningUrl != "" {
+	if vp.TCPListeningURL != "" && vp.WsListeningURL != "" {
-		logger.Infof("running two listeners: tcp port: %s, ws url: %s", vp.TcpListeningUrl, vp.WsListeningUrl)
+		logger.Infof("running two listeners: tcp port: %s, ws url: %s", vp.TCPListeningURL, vp.WsListeningURL)
 
-		go server.WsServe(vp.WsListeningUrl, cfg)
+		go server.WsServe(vp.WsListeningURL, cfg)
-		server.TcpServe(vp.TcpListeningUrl, cfg)
+		server.TcpServe(vp.TCPListeningURL, cfg)
 	}
 
-	if vp.WsListeningUrl != "" {
+	if vp.WsListeningURL != "" {
-		logger.Infof("running ws listener url: %s", vp.WsListeningUrl)
+		logger.Infof("running ws listener url: %s", vp.WsListeningURL)
-		server.WsServe(vp.WsListeningUrl, cfg)
+		server.WsServe(vp.WsListeningURL, cfg)
 	}
-	if vp.TcpListeningUrl != "" {
+	if vp.TCPListeningURL != "" {
-		logger.Infof("running tcp listener on port: %s", vp.TcpListeningUrl)
+		logger.Infof("running tcp listener on port: %s", vp.TCPListeningURL)
-		server.TcpServe(":"+vp.TcpListeningUrl, cfg)
+		server.TcpServe(vp.TCPListeningURL, cfg)
 	}
 }

proxy/vnc-session.go

@@ -16,6 +16,7 @@ const (
 )
 
 type VncSession struct {
+	Target         string
 	TargetHostname string
 	TargetPort     string
 	TargetPassword string

recorder/cmd/main.go

@@ -5,11 +5,11 @@ import (
 	"net"
 	"os"
 	"time"
-	"vncproxy/client"
+	"github.com/amitbet/vncproxy/client"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/encodings"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
-	"vncproxy/recorder"
+	"github.com/amitbet/vncproxy/recorder"
 )
 
 func main() {

recorder/recorder.go

@@ -5,9 +5,9 @@ import (
 	"encoding/binary"
 	"os"
 	"time"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
-	"vncproxy/server"
+	"github.com/amitbet/vncproxy/server"
 )
 
 type Recorder struct {

recorder/rfb-requester.go

@@ -2,9 +2,9 @@ package recorder
 
 import (
 	"time"
-	"vncproxy/client"
+	"github.com/amitbet/vncproxy/client"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 type RfbRequester struct {

server/client-messages.go

@@ -3,7 +3,7 @@ package server
 import (
 	"encoding/binary"
 	"io"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 // Key represents a VNC key press.

server/handlers.go

@@ -3,10 +3,10 @@ package server
 import (
 	"encoding/binary"
 	"fmt"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 
 	"io"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 const ProtoVersionLength = 12

server/security.go

@@ -6,7 +6,7 @@ import (
 	"crypto/rand"
 	"errors"
 	"log"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 type SecurityType uint8

server/server-conn.go

@@ -5,8 +5,8 @@ import (
 	"fmt"
 	"io"
 	"sync"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 )
 
 type ServerConn struct {

server/server.go

@@ -5,7 +5,7 @@ import (
 	"io"
 	"log"
 	"net"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
 )
 
 var DefaultClientMessages = []common.ClientMessage{

server/server_test.go

@@ -3,8 +3,8 @@ package server
 import (
 	"log"
 	"testing"
-	"vncproxy/common"
+	"github.com/amitbet/vncproxy/common"
-	"vncproxy/encodings"
+	"github.com/amitbet/vncproxy/encodings"
 )
 
 func newServerConnHandler(cfg *ServerConfig, conn *ServerConn) error {

server/ws-server-go.go

@@ -4,7 +4,7 @@ import (
 	"io"
 	"net/http"
 	"net/url"
-	"vncproxy/logger"
+	"github.com/amitbet/vncproxy/logger"
 
 	"golang.org/x/net/websocket"
 )