25 Commits

Author SHA1 Message Date
github-actions[bot]
b3adaab63c chore: auto-update Go modules 2026-04-13 00:20:37 +00:00
github-actions[bot]
29ee1afb67 chore: auto-update Go modules 2026-04-06 00:18:32 +00:00
github-actions[bot]
40463b004b chore: auto-update Go modules 2026-03-30 00:17:59 +00:00
b3c4eb9cc9 regen gitignore 2026-03-27 14:04:29 +00:00
7b6b26c7f9 add pre-commit config 2026-03-21 14:01:53 +00:00
github-actions[bot]
dc05e156f0 chore: auto-update Go modules 2026-03-16 00:17:47 +00:00
github-actions[bot]
124344b9a1 chore: auto-update Go modules 2026-03-09 00:13:54 +00:00
github-actions[bot]
251168d2d4 chore: auto-update Go modules 2026-03-02 00:14:07 +00:00
github-actions[bot]
ca006d7d73 chore: auto-update Go modules 2026-02-23 00:14:45 +00:00
225188bb70 use net.JoinHostPort to build addresses 2026-02-18 14:51:35 +00:00
63cf99b217 reword 2026-02-18 14:34:38 +00:00
7a83fd6573 add 1.8.0 to CHANGELOG
fix date of 1.7.3
2026-02-18 14:33:19 +00:00
b494e6cf8f upd Taskfile to match changes to --port-map flag 2026-02-18 14:33:01 +00:00
9be4344144 ports-mapping flag now reimplemented as a StringSliceFlag and renamed to port-map. 2026-02-18 14:32:38 +00:00
775979bfc8 update README 2026-02-18 14:28:31 +00:00
6bffa14240 upd go.mod go.sum 2026-02-16 10:30:50 +00:00
74493e6f61 add 1.7.3 to CHANGELOG 2026-02-16 10:29:34 +00:00
51a0065e79 swap out logrus for charm log 2026-02-16 10:29:27 +00:00
f07a45c81b add macos target to goreleaser config 2026-02-16 10:28:52 +00:00
a70fdecdbb add --version flag
ensure version is injected at build time in Taskfile/makefile
2026-02-16 01:49:28 +00:00
fc6ac8fa4e enable godot, misspell linters 2026-02-15 17:14:34 +00:00
f6ea67b88c enable revive linter 2026-02-15 16:02:07 +00:00
d18834b290 add macos target to makefile/taskfile 2026-02-15 15:56:13 +00:00
46874f2cf5 format fixes 2026-02-15 15:54:02 +00:00
1c5e18294e migrate golangci config to version 2
add golang-ci workflow
2026-02-15 15:53:35 +00:00
16 changed files with 419 additions and 76 deletions

30
.github/workflows/golang-ci.yml vendored Normal file
View File

@@ -0,0 +1,30 @@
name: CI
on:
push:
branches: ['main']
paths:
- '**.go'
pull_request:
branches: ['main']
paths:
- '**.go'
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
timeout-minutes: 3
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.24'
- name: golangci-lint
uses: golangci/golangci-lint-action@v9
with:
version: v2.6.0
args: --config .golangci.yml

24
.gitignore vendored
View File

@@ -1,5 +1,6 @@
# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore
### Go ###
# Generated by ignr: github.com/onyx-and-iris/ignr
## Go ##
# If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
#
@@ -9,20 +10,29 @@
*.dll
*.so
*.dylib
bin/
# Test binary, built with `go test -c`
*.test
# Output of the go coverage tool, specifically when used with LiteIDE
# Code coverage profiles and other test artifacts
*.out
coverage.*
*.coverprofile
profile.cov
# Dependency directories (remove the comment below to include it)
# vendor/
# Go workspace file
go.work
# End of gignore: github.com/onyx-and-iris/gignore
go.work.sum
# Added by goreleaser init:
dist/
# env file
.env
.envrc
# Editor/IDE
# .idea/
# .vscode/
# End of ignr

142
.golangci.yml Normal file
View File

@@ -0,0 +1,142 @@
version: '2'
run:
timeout: 3m
tests: true
go: '1.24'
linters:
disable: [errcheck]
enable:
# Default enabled linters
- errcheck # Check for unchecked errors
- govet # Go's built-in vetting tool
- ineffassign # Detect ineffectual assignments
- staticcheck # Advanced static analysis
- unused # Check for unused code
# Additional useful linters
- misspell # Detect common misspellings
- unparam # Check for unused function parameters
- gosec # Security checks
- asciicheck # Check for non-ASCII characters
- errname # Check error variable names
- godot # Check for missing periods in comments
- revive # Highly configurable linter for style and correctness
- gocritic # Detect code issues and suggest improvements
- gocyclo # Check for cyclomatic complexity
- dupl # Check for code duplication
- predeclared # Check for shadowing of predeclared identifiers
- copyloopvar # Check for loop variable capture in goroutines
- errorlint # Check for common mistakes in error handling
- goconst # Check for repeated strings that could be constants
- gosmopolitan # Check for non-portable code
settings:
misspell:
locale: UK
errcheck:
check-type-assertions: true
check-blank: true
exclude-functions:
- fmt.Fprintf
- fmt.Fprintln
- fmt.Printf
- fmt.Println
- fmt.Errorf
revive:
severity: warning
rules:
# Code quality and style
- name: exported
arguments:
- 'checkPrivateReceivers'
- 'sayRepetitiveInsteadOfStutters'
- name: var-naming
- name: package-comments
- name: range-val-in-closure
- name: time-naming
- name: context-as-argument
- name: context-keys-type
- name: dot-imports
- name: empty-block
- name: error-return
- name: error-strings
- name: error-naming
- name: if-return
- name: increment-decrement
- name: indent-error-flow
- name: receiver-naming
- name: redefines-builtin-id
- name: superfluous-else
- name: unexported-return
- name: unreachable-code
- name: unused-parameter
- name: var-declaration
- name: blank-imports
- name: range
# Disabled rules (can be enabled if needed)
# - name: line-length-limit
# arguments: [120]
# - name: function-length
# arguments: [50, 0]
# - name: cyclomatic
# arguments: [10]
gosec:
excludes:
- G104 # Duplicated errcheck checks
- G115 # integer overflow conversion int -> uint32
exclusions:
warn-unused: false
rules:
# Exclude some linters from running on tests files.
- path: _test\.go
linters:
- gocyclo
- errcheck
- dupl
- gosec
paths:
- vendor
# Formatters configuration
formatters:
# Enable specific formatters
enable:
- gofumpt # Stricter gofmt alternative
- goimports # Organizes imports
- gci # Controls import order/grouping
- golines # Enforces line length
# Formatter-specific settings
settings:
goimports:
local-prefixes: [github.com/onyx-and-iris/q3rcon-proxy]
gci:
# Define import sections order
sections:
- standard # Standard library
- default # Everything else
- prefix(github.com/onyx-and-iris/q3rcon-proxy) # Current module
gofumpt:
extra-rules: true # Enable additional formatting rules
exclusions:
warn-unused: true
paths:
- vendor
issues:
# Limit the number of same issues reported to avoid spam
max-same-issues: 50
# Limit the number of issues per linter to keep output manageable
max-issues-per-linter: 100

View File

@@ -22,6 +22,7 @@ builds:
goos:
- linux
- windows
- darwin
goarch:
- amd64

5
.pre-commit-config.yaml Normal file
View File

@@ -0,0 +1,5 @@
repos:
- repo: https://github.com/tekwizely/pre-commit-golang
rev: v1.0.0-rc.4
hooks:
- id: go-mod-tidy

View File

@@ -11,6 +11,23 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- [x]
## [1.8.0] - 2026-02-18
### Changed
- *--ports-mapping* flag has been replaced with *--port-map*, which may be called several times. See [Flags](https://github.com/onyx-and-iris/q3rcon-proxy?tab=readme-ov-file#flags).
- This also affects the env variable which is now `Q3RCON_PORT_MAP`, see [Environment Variables](https://github.com/onyx-and-iris/q3rcon-proxy?tab=readme-ov-file#environment-variables)
## [1.7.3] - 2026-02-16
### Added
- *--version/-v* flag for printing the version of the CLI.
### Changed
- now using [charmbracelet/log][charmlog] package for logging.
## [1.7.0] - 2025-06-05
### Added
@@ -99,3 +116,4 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- All source files for lilproxy including full commit history.
[logrus]: https://github.com/sirupsen/logrus
[charmlog]: https://github.com/charmbracelet/log

View File

@@ -5,24 +5,27 @@ BIN_DIR := bin
WINDOWS=$(BIN_DIR)/$(PROGRAM)_windows_amd64.exe
LINUX=$(BIN_DIR)/$(PROGRAM)_linux_amd64
VERSION=$(shell git log -n 1 --format=%h)
MACOS=$(BIN_DIR)/$(PROGRAM)_darwin_amd64
VERSION=$(shell git describe --tags $(shell git rev-list --tags --max-count=1))
.DEFAULT_GOAL := build
.PHONY: fmt vet build windows linux test clean
.PHONY: fmt vet build windows linux macos test clean
fmt:
$(GO) fmt ./...
vet: fmt
$(GO) vet ./...
build: vet windows linux | $(BIN_DIR)
build: vet windows linux macos | $(BIN_DIR)
@echo version: $(VERSION)
windows: $(WINDOWS)
linux: $(LINUX)
macos: $(MACOS)
$(WINDOWS):
env GOOS=windows GOARCH=amd64 go build -v -o $(WINDOWS) -ldflags="-s -w -X main.version=$(VERSION)" ./cmd/$(PROGRAM)/
@@ -30,6 +33,9 @@ $(WINDOWS):
$(LINUX):
env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)" ./cmd/$(PROGRAM)/
$(MACOS):
env GOOS=darwin GOARCH=amd64 go build -v -o $(MACOS) -ldflags="-s -w -X main.version=$(VERSION)" ./cmd/$(PROGRAM)/
test:
$(GO) test ./...

View File

@@ -6,6 +6,8 @@ A modification of [lilproxy][lilproxy_url] that forwards only Q3 rcon/query pack
Unfortunately the Q3Rcon engine ties the rcon port to the game servers public port used for client connections. This proxy will allow you to run rcon through a separate whitelisted port.
---
### Use
#### Flags
@@ -16,7 +18,7 @@ Unfortunately the Q3Rcon engine ties the rcon port to the game servers public po
/usr/local/bin/q3rcon-proxy \
--proxy-host=0.0.0.0 \
--target-host=localhost \
--ports-mapping=28961:28960 \
--port-map=20000:28960 --port-map=20001:28961 --port-map=20002:28962 \
--session-timeout=20 \
--loglevel=debug
```
@@ -27,18 +29,25 @@ Each of the flags has a corresponding environment variable:
- `Q3RCON_PROXY_HOST`: The host the proxy server sits on.
- `Q3RCON_TARGET_HOST`: The host the game servers sit on.
- `Q3RCON_PORTS_MAPPING`: A mapping as a string with `source:target` pairs delimited by `;`.
- `Q3RCON_PORT_MAP`: A mapping as a string with `source:target` pairs delimited by `,`.
- `Q3RCON_SESSION_TIMEOUT`: Timeout in seconds for each udp session.
- `Q3RCON_LOGLEVEL`: The application's logging level (see [Logging][logging]).
Multiple rcon proxies may be configured by setting *--ports-mapping/Q3RCON_PORTS_MAPPING* like so:
example .envrc:
```console
export Q3RCON_PORTS_MAPPING="20000:28960;20001:28961;20002:28962"
```bash
#!/usr/bin/env bash
export Q3RCON_PROXY_HOST="0.0.0.0"
export Q3RCON_TARGET_HOST="localhost"
export Q3RCON_PORT_MAP="20000:28960,20001:28961,20002:28962"
export Q3RCON_SESSION_TIMEOUT=20
```
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.
---
### Logging
Set the log level with environment variable `Q3RCON_LOGLEVEL`.
@@ -53,7 +62,9 @@ Acceptable values are:
- `fatal`
- `panic`
If not set it will default to `info`.
It defaults to `info`.
---
### Special Thanks

View File

@@ -10,8 +10,9 @@ vars:
WINDOWS: '{{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe'
LINUX: '{{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64'
GIT_COMMIT:
sh: git log -n 1 --format=%h
MACOS: '{{.BIN_DIR}}/{{.PROGRAM}}_darwin_amd64'
VERSION:
sh: 'git describe --tags $(git rev-list --tags --max-count=1)'
tasks:
default:
@@ -25,6 +26,7 @@ tasks:
cmds:
- task: build-windows
- task: build-linux
- task: build-macos
vet:
desc: Vet the code
@@ -40,13 +42,19 @@ tasks:
build-windows:
desc: Build the q3rcon-proxy project for Windows
cmds:
- GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
- GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.version={{.VERSION}}" ./cmd/{{.PROGRAM}}/
internal: true
build-linux:
desc: Build the q3rcon-proxy project for Linux
cmds:
- GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}/
- GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.version={{.VERSION}}" ./cmd/{{.PROGRAM}}/
internal: true
build-macos:
desc: Build the q3rcon-proxy project for macOS
cmds:
- GOOS=darwin GOARCH=amd64 go build -o {{.MACOS}} -ldflags="-X main.version={{.VERSION}}" ./cmd/{{.PROGRAM}}/
internal: true
test:
@@ -66,6 +74,6 @@ tasks:
go run ./cmd/{{.PROGRAM}} \
--proxy-host=0.0.0.0 \
--target-host=localhost \
--ports-mapping=28961:28960 \
--port-map=28961:28960 \
--session-timeout=20 \
--loglevel=debug

View File

@@ -1,18 +1,37 @@
// Package main implements a command-line application for a Quake 3 RCON proxy server.
package main
import (
"context"
"fmt"
"net"
"os"
"runtime/debug"
"strconv"
"strings"
"time"
udpproxy "github.com/onyx-and-iris/q3rcon-proxy"
log "github.com/sirupsen/logrus"
"github.com/charmbracelet/log"
"github.com/urfave/cli/v3"
udpproxy "github.com/onyx-and-iris/q3rcon-proxy"
)
var version string // Version holds the application version, set at build time using ldflags.
// versionFromBuild retrieves the version information from the build metadata.
func versionFromBuild() string {
if version != "" {
return version
}
info, ok := debug.ReadBuildInfo()
if !ok {
return "(unable to read version)"
}
return strings.Split(info.Main.Version, "-")[0]
}
// proxyConfig holds the configuration for a single UDP proxy server.
type proxyConfig struct {
proxyHost string
@@ -22,9 +41,14 @@ type proxyConfig struct {
}
func main() {
cli.VersionPrinter = func(cmd *cli.Command) {
fmt.Printf("q3rcon-proxy version: %s\n", cmd.Root().Version)
}
cmd := &cli.Command{
Name: "q3rcon-proxy",
Usage: "A Quake 3 RCON proxy server",
Version: versionFromBuild(),
Flags: []cli.Flag{
&cli.StringFlag{
Name: "proxy-host",
@@ -38,29 +62,47 @@ func main() {
Usage: "Target host address",
Sources: cli.EnvVars("Q3RCON_TARGET_HOST"),
},
&cli.StringFlag{
Name: "ports-mapping",
Usage: "Proxy and target ports (proxy:target)",
Sources: cli.EnvVars("Q3RCON_PORTS_MAPPING"),
&cli.StringSliceFlag{
Name: "port-map",
Usage: "Ports mapping in the format proxyPort:targetPort (e.g., 27950:27960)",
Sources: cli.EnvVars("Q3RCON_PORT_MAP"),
Required: true,
Action: func(ctx context.Context, cmd *cli.Command, v string) error {
// Validate the ports mapping
for mapping := range strings.SplitSeq(v, ";") {
ports := strings.Split(mapping, ":")
if len(ports) != 2 {
return fmt.Errorf("invalid ports mapping: %s", mapping)
Action: func(_ context.Context, cmd *cli.Command, v []string) error {
// Validate the ports mapping format and values
for _, mapping := range v {
src, dst := func(m string) (string, string) {
parts := strings.Split(m, ":")
if len(parts) != 2 {
return "", ""
}
proxyPort, err := strconv.Atoi(ports[0])
if err != nil || proxyPort < 1 || proxyPort > 65535 {
return fmt.Errorf("invalid proxy port: %s", ports[0])
return parts[0], parts[1]
}(mapping)
if src == "" || dst == "" {
return fmt.Errorf(
"invalid ports mapping: %s (expected format: proxyPort:targetPort)",
mapping,
)
}
targetPort, err := strconv.Atoi(ports[1])
if err != nil || targetPort < 1 || targetPort > 65535 {
return fmt.Errorf("invalid target port: %s", ports[1])
n, err := strconv.Atoi(src)
if err != nil || n <= 0 || n > 65535 {
return fmt.Errorf("invalid proxy port: %s", src)
}
if proxyPort == targetPort {
return fmt.Errorf("proxy and target ports cannot be the same: %s", mapping)
n, err = strconv.Atoi(dst)
if err != nil || n <= 0 || n > 65535 {
return fmt.Errorf("invalid target port: %s", dst)
}
if src == dst {
return fmt.Errorf(
"proxy port and target port cannot be the same: %s",
src,
)
}
log.Debugf(
"Validated ports mapping: proxy port %s -> target port %s",
src,
dst,
)
}
return nil
},
@@ -89,7 +131,7 @@ func main() {
Action: func(_ context.Context, cmd *cli.Command) error {
errChan := make(chan error)
for mapping := range strings.SplitSeq(cmd.String("ports-mapping"), ";") {
for _, mapping := range cmd.StringSlice("port-map") {
cfg := proxyConfig{
proxyHost: cmd.String("proxy-host"),
targetHost: cmd.String("target-host"),
@@ -106,27 +148,29 @@ func main() {
},
}
log.Fatal(cmd.Run(context.Background(), os.Args))
if err := cmd.Run(context.Background(), os.Args); err != nil {
log.Fatal(err)
}
}
// launchProxy initializes the UDP proxy server with the given configuration.
// launchProxy initialises the UDP proxy server with the given configuration.
// It listens on the specified proxy host and port, and forwards traffic to the target host and port.
// server.ListenAndServe blocks until the server is stopped or an error occurs.
func launchProxy(cfg proxyConfig, errChan chan<- error) {
proxyPort, targetPort := cfg.portsMapping[0], cfg.portsMapping[1]
hostAddr := fmt.Sprintf("%s:%s", cfg.proxyHost, proxyPort)
proxyAddr := fmt.Sprintf("%s:%s", cfg.targetHost, targetPort)
proxyAddr := net.JoinHostPort(cfg.proxyHost, proxyPort)
targetAddr := net.JoinHostPort(cfg.targetHost, targetPort)
server, err := udpproxy.New(
hostAddr, proxyAddr,
proxyAddr, targetAddr,
udpproxy.WithSessionTimeout(time.Duration(cfg.sessionTimeout)*time.Minute))
if err != nil {
errChan <- fmt.Errorf("failed to create proxy: %w", err)
return
}
log.Printf("q3rcon-proxy initialized: [proxy] (%s) [target] (%s)", hostAddr, proxyAddr)
log.Infof("q3rcon-proxy initialised: [proxy] (%s) [target] (%s)", proxyAddr, targetAddr)
errChan <- server.ListenAndServe()
}

28
go.mod
View File

@@ -1,12 +1,28 @@
module github.com/onyx-and-iris/q3rcon-proxy
go 1.24.0
toolchain go1.24.1
go 1.25.0
require (
github.com/sirupsen/logrus v1.9.4
github.com/urfave/cli/v3 v3.6.2
github.com/charmbracelet/log v1.0.0
github.com/urfave/cli/v3 v3.8.0
)
require golang.org/x/sys v0.41.0 // indirect
require (
github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
github.com/charmbracelet/colorprofile v0.4.3 // indirect
github.com/charmbracelet/lipgloss v1.1.0 // indirect
github.com/charmbracelet/x/ansi v0.11.6 // indirect
github.com/charmbracelet/x/cellbuf v0.0.15 // indirect
github.com/charmbracelet/x/term v0.2.2 // indirect
github.com/clipperhouse/displaywidth v0.11.0 // indirect
github.com/clipperhouse/uax29/v2 v2.7.0 // indirect
github.com/go-logfmt/logfmt v0.6.1 // indirect
github.com/lucasb-eyer/go-colorful v1.4.0 // indirect
github.com/mattn/go-isatty v0.0.21 // indirect
github.com/mattn/go-runewidth v0.0.23 // indirect
github.com/muesli/termenv v0.16.0 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f // indirect
golang.org/x/sys v0.43.0 // indirect
)

46
go.sum
View File

@@ -1,14 +1,48 @@
github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
github.com/charmbracelet/colorprofile v0.4.3 h1:QPa1IWkYI+AOB+fE+mg/5/4HRMZcaXex9t5KX76i20Q=
github.com/charmbracelet/colorprofile v0.4.3/go.mod h1:/zT4BhpD5aGFpqQQqw7a+VtHCzu+zrQtt1zhMt9mR4Q=
github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY=
github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30=
github.com/charmbracelet/log v1.0.0 h1:HVVVMmfOorfj3BA9i8X8UL69Hoz9lI0PYwXfJvOdRc4=
github.com/charmbracelet/log v1.0.0/go.mod h1:uYgY3SmLpwJWxmlrPwXvzVYujxis1vAKRV/0VQB7yWA=
github.com/charmbracelet/x/ansi v0.11.6 h1:GhV21SiDz/45W9AnV2R61xZMRri5NlLnl6CVF7ihZW8=
github.com/charmbracelet/x/ansi v0.11.6/go.mod h1:2JNYLgQUsyqaiLovhU2Rv/pb8r6ydXKS3NIttu3VGZQ=
github.com/charmbracelet/x/cellbuf v0.0.15 h1:ur3pZy0o6z/R7EylET877CBxaiE1Sp1GMxoFPAIztPI=
github.com/charmbracelet/x/cellbuf v0.0.15/go.mod h1:J1YVbR7MUuEGIFPCaaZ96KDl5NoS0DAWkskup+mOY+Q=
github.com/charmbracelet/x/term v0.2.2 h1:xVRT/S2ZcKdhhOuSP4t5cLi5o+JxklsoEObBSgfgZRk=
github.com/charmbracelet/x/term v0.2.2/go.mod h1:kF8CY5RddLWrsgVwpw4kAa6TESp6EB5y3uxGLeCqzAI=
github.com/clipperhouse/displaywidth v0.11.0 h1:lBc6kY44VFw+TDx4I8opi/EtL9m20WSEFgwIwO+UVM8=
github.com/clipperhouse/displaywidth v0.11.0/go.mod h1:bkrFNkf81G8HyVqmKGxsPufD3JhNl3dSqnGhOoSD/o0=
github.com/clipperhouse/uax29/v2 v2.7.0 h1:+gs4oBZ2gPfVrKPthwbMzWZDaAFPGYK72F0NJv2v7Vk=
github.com/clipperhouse/uax29/v2 v2.7.0/go.mod h1:EFJ2TJMRUaplDxHKj1qAEhCtQPW2tJSwu5BF98AuoVM=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/go-logfmt/logfmt v0.6.1 h1:4hvbpePJKnIzH1B+8OR/JPbTx37NktoI9LE2QZBBkvE=
github.com/go-logfmt/logfmt v0.6.1/go.mod h1:EV2pOAQoZaT1ZXZbqDl5hrymndi4SY9ED9/z6CO0XAk=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/lucasb-eyer/go-colorful v1.4.0 h1:UtrWVfLdarDgc44HcS7pYloGHJUjHV/4FwW4TvVgFr4=
github.com/lucasb-eyer/go-colorful v1.4.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
github.com/mattn/go-isatty v0.0.21 h1:xYae+lCNBP7QuW4PUnNG61ffM4hVIfm+zUzDuSzYLGs=
github.com/mattn/go-isatty v0.0.21/go.mod h1:ZXfXG4SQHsB/w3ZeOYbR0PrPwLy+n6xiMrJlRFqopa4=
github.com/mattn/go-runewidth v0.0.23 h1:7ykA0T0jkPpzSvMS5i9uoNn2Xy3R383f9HDx3RybWcw=
github.com/mattn/go-runewidth v0.0.23/go.mod h1:XBkDxAl56ILZc9knddidhrOlY5R/pDhgLpndooCuJAs=
github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc=
github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w=
github.com/sirupsen/logrus v1.9.4/go.mod h1:ftWc9WdOfJ0a92nsE2jF5u5ZwH8Bv2zdeOC42RjbV2g=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
github.com/urfave/cli/v3 v3.6.2 h1:lQuqiPrZ1cIz8hz+HcrG0TNZFxU70dPZ3Yl+pSrH9A8=
github.com/urfave/cli/v3 v3.6.2/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=
golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
github.com/urfave/cli/v3 v3.8.0 h1:XqKPrm0q4P0q5JpoclYoCAv0/MIvH/jZ2umzuf8pNTI=
github.com/urfave/cli/v3 v3.8.0/go.mod h1:ysVLtOEmg2tOy6PknnYVhDoouyC/6N42TMeoMzskhso=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f h1:W3F4c+6OLc6H2lb//N1q4WpJkhzJCK5J6kUi1NTVXfM=
golang.org/x/exp v0.0.0-20260410095643-746e56fc9e2f/go.mod h1:J1xhfL/vlindoeF/aINzNzt2Bket5bjo9sdOYzOsU80=
golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

View File

@@ -3,17 +3,19 @@ package udpproxy
import (
"time"
log "github.com/sirupsen/logrus"
"github.com/charmbracelet/log"
)
// Option is a functional option type that allows us to configure the Client.
type Option func(*Client)
// WithSessionTimeout is a functional option to set the session timeout
// WithSessionTimeout is a functional option to set the session timeout.
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 20 minutes")
log.Warnf(
"cannot set stale session timeout to less than 1 minute.. defaulting to 20 minutes",
)
return
}

View File

@@ -7,7 +7,7 @@ import (
"strings"
"time"
log "github.com/sirupsen/logrus"
"github.com/charmbracelet/log"
)
type session struct {
@@ -19,7 +19,7 @@ type session struct {
validator
}
func newSession(caddr *net.UDPAddr, raddr *net.UDPAddr, proxyConn *net.UDPConn) (*session, error) {
func newSession(caddr, raddr *net.UDPAddr, proxyConn *net.UDPConn) (*session, error) {
serverConn, err := net.DialUDP("udp", nil, raddr)
if err != nil {
return nil, err
@@ -81,7 +81,11 @@ func (s *session) proxyTo(buf []byte) error {
var err error
if s.isChallengeRequestPacket(buf) {
parts := strings.SplitN(string(buf), " ", 3)
err = fmt.Errorf("invalid challenge from %s with GUID: %s", s.caddr.IP, parts[len(parts)-1])
err = fmt.Errorf(
"invalid challenge from %s with GUID: %s",
s.caddr.IP,
parts[len(parts)-1],
)
} else {
err = errors.New("not a rcon or query request packet")
}
@@ -98,7 +102,12 @@ func (s *session) proxyTo(buf []byte) error {
if s.isRconRequestPacket(buf) {
parts := strings.SplitN(string(buf), " ", 3)
log.Infof("From [%s] To [%s] Command: %s", s.caddr.IP, s.serverConn.RemoteAddr(), parts[len(parts)-1])
log.Infof(
"From [%s] To [%s] Command: %s",
s.caddr.IP,
s.serverConn.RemoteAddr(),
parts[len(parts)-1],
)
}
return nil

View File

@@ -2,7 +2,7 @@ package udpproxy
import "sync"
// sessionCache tracks connection sessions
// sessionCache tracks connection sessions.
type sessionCache struct {
mu sync.RWMutex
data map[string]*session
@@ -15,7 +15,7 @@ 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) {
sc.mu.RLock()
defer sc.mu.RUnlock()

View File

@@ -1,12 +1,16 @@
// Package udpproxy implements a simple UDP proxy server that forwards rcon and query packets between clients and a target server.
package udpproxy
import (
"fmt"
"net"
"time"
log "github.com/sirupsen/logrus"
"github.com/charmbracelet/log"
)
// Client represents a UDP proxy server that forwards rcon and query packets between clients and a target server.
// It maintains a session cache to manage client sessions and handles packet forwarding between clients and the target server.
type Client struct {
laddr *net.UDPAddr
raddr *net.UDPAddr
@@ -17,15 +21,16 @@ type Client struct {
sessionTimeout time.Duration
}
// New creates a new Client with the specified proxy and target addresses, and applies any provided options.
func New(proxy, target string, options ...Option) (*Client, error) {
laddr, err := net.ResolveUDPAddr("udp", proxy)
if err != nil {
return nil, err
return nil, fmt.Errorf("invalid proxy address: %w", err)
}
raddr, err := net.ResolveUDPAddr("udp", target)
if err != nil {
return nil, err
return nil, fmt.Errorf("invalid target address: %w", err)
}
c := &Client{
@@ -42,11 +47,13 @@ func New(proxy, target string, options ...Option) (*Client, error) {
return c, nil
}
// ListenAndServe starts the UDP proxy server and listens for incoming packets from clients.
// It reads packets from the proxy connection, checks for existing sessions, and forwards packets to the target server.
func (c *Client) ListenAndServe() error {
var err error
c.proxyConn, err = net.ListenUDP("udp", c.laddr)
if err != nil {
return err
return fmt.Errorf("failed to listen on proxy address: %w", err)
}
go c.pruneSessions()
@@ -80,7 +87,7 @@ func (c *Client) pruneSessions() {
for _, session := range c.sessionCache.data {
if time.Since(session.updateTime) > c.sessionTimeout {
c.sessionCache.delete(session.caddr.String())
log.Tracef("session for %s deleted", session.caddr)
log.Debugf("session for %s deleted", session.caddr)
}
}
}