updated changelog with dates.

stale session timeout default value increased

.dockerignore

@@ -0,0 +1,6 @@
+*
+!cmd/
+!pkg/
+
+!go.mod
+!go.sum

.gitignore

@@ -7,6 +7,7 @@
 *.dll
 *.so
 *.dylib
+bin/
 
 # Test binary, built with `go test -c`
 *.test

CHANGELOG.md

@@ -11,6 +11,38 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
 
 -   [x]
 
+## [1.4.0] - 2024-11-29
+
+### Added
+
+-   new environment variable `Q3RCON_TARGET_HOST` for setting the host the gameserver is on.
+
+### Changed
+
+-   environment variable `Q3RCON_HOST` renamed to `Q3RCON_PROXY_HOST`
+-   environment variable `Q3RCON_PROXY` renamed to `Q3RCON_TARGET_PORTS`.
+-   default session timeout changed from 5 to 20 minutes.
+
+## [1.3.0] - 2024-10-23
+
+### Added
+
+-   Add sessionCache for tracking sessions.
+-   Functional option `WithStaleTimeout` renamed to `WithSessionTimeout`
+
+## [1.2.0] - 2024-10-19
+
+### Added
+
+-   optional function `WithStaleTimeout`, use it to configure the session timeout value.
+    -   it defaults to 5 minutes.
+
+## [1.1.0] - 2024-09-28
+
+### Added
+
+-   connection (challenge) requests are now logged.
+
 ## [0.6.0] - 2024-03-21
 
 ### Added

Makefile

@@ -1,2 +1,40 @@
-go-build:
+program = q3rcon-proxy
-	go build ./cmd/q3rcon-proxy/
+
+GO = @go
+BIN_DIR := bin
+
+WINDOWS=$(BIN_DIR)/$(program)_windows_amd64.exe
+LINUX=$(BIN_DIR)/$(program)_linux_amd64
+VERSION=$(shell git describe --tags --always --long --dirty)
+
+.DEFAULT_GOAL := build
+
+.PHONY: fmt vet build windows linux test clean
+fmt:        
+	$(GO) fmt ./...
+
+vet: fmt        
+	$(GO) vet ./...
+
+build: vet windows linux | $(BIN_DIR)
+	@echo version: $(VERSION)
+
+windows: $(WINDOWS)
+
+linux: $(LINUX)
+
+
+$(WINDOWS):
+	env GOOS=windows GOARCH=amd64 go build -v -o $(WINDOWS) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/q3rcon-proxy/
+
+$(LINUX):
+	env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)"  ./cmd/q3rcon-proxy/
+
+test:
+	$(GO) test ./...
+
+$(BIN_DIR):
+	@mkdir -p $@
+
+clean:
+	@rm -rv $(BIN_DIR)

README.md

@@ -8,12 +8,12 @@ Unfortunately the Q3Rcon engine ties the rcon port to the game servers public po
 
 ### Use
 
-Run one or multiple rcon proxies by setting an environment variable `Q3RCON_PROXY`
+Run one or multiple rcon proxies by setting an environment variable `Q3RCON_TARGET_PORTS`
 
 for example:
 
 ```bash
-export Q3RCON_PROXY="20000:28960;20001:28961;20002:28962"
+export Q3RCON_TARGET_PORTS="20000:28960;20001:28961;20002:28962"
 ```
 
 This would configure q3rcon-proxy to run 3 proxy servers listening on ports `20000`, `20001` and `20002` that redirect rcon requests to game servers on ports `28960`, `28961` and `28962` respectively.
@@ -32,3 +32,9 @@ Set the log level with environment variable `Q3RCON_LOGLEVEL`:
 
 [lilproxy_url]: https://github.com/dgparker/lilproxy
 [user_link]: https://github.com/dgparker
+
+### Further Notes
+
+For a compatible rcon client also written in Go consider checking out the [Q3 Rcon][q3rcon] package.
+
+[q3rcon]: https://github.com/onyx-and-iris/q3rcon

cmd/q3rcon-proxy/main.go

@@ -21,43 +21,53 @@ func main() {
 		log.SetLevel(log.Level(logLevel))
 	}
 
-	proxies := os.Getenv("Q3RCON_PROXY")
+	proxyHost := os.Getenv("Q3RCON_PROXY_HOST")
-	if proxies == "" {
+	if proxyHost == "" {
-		log.Fatal("env Q3RCON_PROXY required")
+		proxyHost = "0.0.0.0"
 	}
 
-	host := os.Getenv("Q3RCON_HOST")
+	targetHost := os.Getenv("Q3RCON_TARGET_HOST")
-	if host == "" {
+	if targetHost == "" {
-		host = "0.0.0.0"
+		targetHost = "127.0.0.1"
+	}
+
+	proxies := os.Getenv("Q3RCON_TARGET_PORTS")
+	if proxies == "" {
+		log.Fatal("env Q3RCON_TARGET_PORTS required")
 	}
 
 	sessionTimeout, err := getEnvInt("Q3RCON_SESSION_TIMEOUT")
 	if err != nil {
 		log.Fatalf("unable to parse Q3RCON_SESSION_TIMEOUT: %s", err.Error())
 	}
-
+	if sessionTimeout == 0 {
-	for _, proxy := range strings.Split(proxies, ";") {
+		sessionTimeout = 20
-		go start(host, proxy, sessionTimeout)
 	}
 
-	<-make(chan int)
+	for _, proxy := range strings.Split(proxies, ";") {
+		go start(proxyHost, targetHost, proxy, sessionTimeout)
+	}
+
+	<-make(chan struct{})
 }
 
-func start(host, proxy string, sessionTimeout int) {
+func start(proxyHost, targetHost, ports string, sessionTimeout int) {
-	port, target := func() (string, string) {
+	proxyPort, targetPort := func() (string, string) {
-		x := strings.Split(proxy, ":")
+		x := strings.Split(ports, ":")
 		return x[0], x[1]
 	}()
 
+	hostAddr := fmt.Sprintf("%s:%s", proxyHost, proxyPort)
+	proxyAddr := fmt.Sprintf("%s:%s", targetHost, targetPort)
+
 	c, err := udpproxy.New(
-		fmt.Sprintf("%s:%s", host, port),
+		hostAddr, proxyAddr,
-		fmt.Sprintf("127.0.0.1:%s", target),
 		udpproxy.WithSessionTimeout(time.Duration(sessionTimeout)*time.Minute))
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	log.Printf("q3rcon-proxy initialized: [proxy] (%s:%s) [target] (127.0.0.1:%s)", host, port, target)
+	log.Printf("q3rcon-proxy initialized: [proxy] (%s) [target] (%s)", hostAddr, proxyAddr)
 
 	log.Fatal(c.ListenAndServe())
 }

pkg/udpproxy/sessioncache.go

@@ -15,8 +15,8 @@ func newSessionCache() sessionCache {
 	}
 }
 
-// Read returns the associated session for an addr
+// read returns the associated session for an addr
-func (sc *sessionCache) Read(addr string) (*session, bool) {
+func (sc *sessionCache) read(addr string) (*session, bool) {
 	sc.mu.RLock()
 	defer sc.mu.RUnlock()
 
@@ -24,16 +24,16 @@ func (sc *sessionCache) Read(addr string) (*session, bool) {
 	return v, ok
 }
 
-// Upsert overrides the session for a given addr.
+// insert adds a session for a given addr.
-func (sc *sessionCache) Upsert(addr string, session *session) {
+func (sc *sessionCache) insert(addr string, session *session) {
 	sc.mu.Lock()
 	defer sc.mu.Unlock()
 
 	sc.data[addr] = session
 }
 
-// Delete removes the session for the given addr.
+// delete removes the session for the given addr.
-func (sc *sessionCache) Delete(addr string) {
+func (sc *sessionCache) delete(addr string) {
 	sc.mu.Lock()
 	defer sc.mu.Unlock()
 

pkg/udpproxy/udpproxy.go

@@ -14,7 +14,7 @@ type Option func(*Client)
 func WithSessionTimeout(timeout time.Duration) Option {
 	return func(c *Client) {
 		if timeout < time.Minute {
-			log.Warnf("cannot set stale session timeout to less than 1 minute.. defaulting to 5 minutes")
+			log.Warnf("cannot set stale session timeout to less than 1 minute.. defaulting to 20 minutes")
 			return
 		}
 
@@ -32,8 +32,8 @@ type Client struct {
 	sessionTimeout time.Duration
 }
 
-func New(port, target string, options ...Option) (*Client, error) {
+func New(proxy, target string, options ...Option) (*Client, error) {
-	laddr, err := net.ResolveUDPAddr("udp", port)
+	laddr, err := net.ResolveUDPAddr("udp", proxy)
 	if err != nil {
 		return nil, err
 	}
@@ -47,7 +47,7 @@ func New(port, target string, options ...Option) (*Client, error) {
 		laddr:          laddr,
 		raddr:          raddr,
 		sessionCache:   newSessionCache(),
-		sessionTimeout: 5 * time.Minute,
+		sessionTimeout: 20 * time.Minute,
 	}
 
 	for _, o := range options {
@@ -73,7 +73,7 @@ func (c *Client) ListenAndServe() error {
 			log.Error(err)
 		}
 
-		session, ok := c.sessionCache.Read(caddr.String())
+		session, ok := c.sessionCache.read(caddr.String())
 		if !ok {
 			session, err = newSession(caddr, c.raddr, c.proxyConn)
 			if err != nil {
@@ -81,7 +81,7 @@ func (c *Client) ListenAndServe() error {
 				continue
 			}
 
-			c.sessionCache.Upsert(caddr.String(), session)
+			c.sessionCache.insert(caddr.String(), session)
 		}
 
 		go session.proxyTo(buf[:n])
@@ -94,7 +94,7 @@ func (c *Client) pruneSessions() {
 	for range ticker.C {
 		for _, session := range c.sessionCache.data {
 			if time.Since(session.updateTime) > c.sessionTimeout {
-				c.sessionCache.Delete(session.caddr.String())
+				c.sessionCache.delete(session.caddr.String())
 				log.Tracef("session for %s deleted", session.caddr)
 			}
 		}