Compare commits

...

40 Commits
v1.1.0 ... dev

Author SHA1 Message Date
github-actions[bot]
0116d3dbe1 chore: auto-update Go modules 2025-06-16 00:10:41 +00:00
github-actions[bot]
7897348669 chore: auto-update Go modules 2025-05-12 00:10:39 +00:00
6489d1e556 return value straight from errChan 2025-05-12 00:01:00 +01:00
d0e3f5863a rename initProxy to launchProxy
remove double log on error

add some explanatory comments.
2025-05-07 16:16:35 +01:00
a00796254d move the functional option into option.go 2025-05-07 16:15:32 +01:00
80ef18f705 upd .dockerignore 2025-05-07 15:56:44 +01:00
40d79063f5 add validation logic to ports-mapping flag 2025-05-07 15:41:34 +01:00
02e73a21c0 move udpproxy files into repo root 2025-05-07 11:38:24 +01:00
5e399b8590 set loglevel in Before function 2025-05-07 00:30:47 +01:00
28baa2ed00 upd launch config 2025-05-07 00:06:01 +01:00
58c95879cc upd debian service example 2025-05-06 23:57:48 +01:00
af0a72eb67 remove redundant function getEnvInt 2025-05-06 23:52:50 +01:00
0d85129d31 add section 1.7.0 to readme 2025-05-06 23:44:30 +01:00
bf7bd4f5b8 add run task 2025-05-06 23:43:54 +01:00
a13d3d7da3 rewrite cli component with urfave/cli 2025-05-06 23:43:47 +01:00
a0c1f15ef0 fix example 2025-05-06 23:42:32 +01:00
e0dc2c02d9 fix link 2025-05-06 23:40:46 +01:00
514688b9ce typo 2025-05-06 23:39:34 +01:00
43183717f6 upd readme 2025-05-06 23:38:31 +01:00
github-actions[bot]
464fbec85f chore: auto-update Go modules 2025-04-07 00:10:03 +00:00
fd51761ab5 update loglevel to str env var 2025-04-06 00:01:36 +01:00
16e5e9c010 upd vars 2025-03-16 01:34:01 +00:00
916d2a2d86 add docker tasks 2025-03-16 01:04:16 +00:00
github-actions[bot]
1bbe3102ce chore: auto-update Go modules 2025-03-10 00:07:55 +00:00
github-actions[bot]
f1762cf3ad chore: auto-update Go modules 2025-02-24 00:09:17 +00:00
386aab510e add update and release actions 2025-02-17 13:37:33 +00:00
c8fd7a3f22 run through formatter 2025-02-07 23:19:05 +00:00
db1c45a25b add taskfile 2025-02-03 18:25:39 +00:00
a1ecf85cbb updated changelog with dates. 2024-11-29 15:25:56 +00:00
6c83d6ad2c add multi platform targets to makefile 2024-11-29 04:34:12 +00:00
c2266ac9d9 target host is now configurable.
stale session timeout default value increased
2024-11-29 04:33:47 +00:00
b0a6ba8180 add link to q3rcon client 2024-11-29 04:29:18 +00:00
9b4a05c0f4 add .dockerignore 2024-11-12 10:12:36 +00:00
bfe31c28c8 no need to export sessionCache methods
rename upsert to insert since we only call it if there isn't a session.
2024-10-23 17:22:03 +01:00
abc1ea9d3f rename Q3RCON_STALE_SESSION_TIMEOUT to Q3RCON_SESSION_TIMEOUT 2024-10-23 16:45:05 +01:00
82ca15f70e add sessionCache, use it to store sessions. 2024-10-23 16:44:35 +01:00
8cb5bc03c5 upd comment 2024-10-19 22:01:47 +01:00
939d419438 use multi-stage build 2024-10-19 21:59:24 +01:00
c42df03858 read from env var Q3RCON_STALE_SESSION_TIMEOUT 2024-10-19 21:19:33 +01:00
64c1df645d add WithStaleTimeout Option function.
add a trace level log when a session gets deleted.
2024-10-19 21:19:03 +01:00
23 changed files with 590 additions and 108 deletions

6
.dockerignore Normal file
View File

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

31
.github/workflows/release.yml vendored Normal file
View File

@ -0,0 +1,31 @@
name: goreleaser
on:
push:
tags:
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
permissions:
contents: write
jobs:
goreleaser:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
-
name: Set up Go
uses: actions/setup-go@v5
-
name: Run GoReleaser
uses: goreleaser/goreleaser-action@v6
with:
distribution: goreleaser
version: '~> v2'
args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

30
.github/workflows/update-go-modules.yml vendored Normal file
View File

@ -0,0 +1,30 @@
name: Auto-Update Go Modules
on:
schedule:
- cron: "0 0 * * 1" # Runs every Monday at midnight
jobs:
update-go-modules:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout Code
uses: actions/checkout@v4
- name: Set up Go
uses: actions/setup-go@v5
with:
go-version: stable
- name: Update Dependencies
run: |
go get -u ./...
go mod tidy
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add go.mod go.sum
git commit -m "chore: auto-update Go modules"
git push

9
.gitignore vendored
View File

@ -1,3 +1,5 @@
# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore
### 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
#
@ -7,6 +9,7 @@
*.dll
*.so
*.dylib
bin/
# Test binary, built with `go test -c`
*.test
@ -19,7 +22,7 @@
# Go workspace file
go.work
# End of gignore: github.com/onyx-and-iris/gignore
# testing
run.sh
server.yaml
# Added by goreleaser init:
dist/

55
.goreleaser.yaml Normal file
View File

@ -0,0 +1,55 @@
# This is an example .goreleaser.yml file with some sensible defaults.
# Make sure to check the documentation at https://goreleaser.com
# The lines below are called `modelines`. See `:help modeline`
# Feel free to remove those if you don't want/need to use them.
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
# vim: set ts=2 sw=2 tw=0 fo=cnqoj
version: 2
before:
hooks:
# You may remove this if you don't use go modules.
- go mod tidy
# you may remove this if you don't need go generate
- go generate ./...
builds:
- main: ./cmd/q3rcon-proxy/
env:
- CGO_ENABLED=0
goos:
- linux
- windows
goarch:
- amd64
archives:
- formats: ['tar.gz']
# this name template makes the OS and Arch compatible with the results of `uname`.
name_template: >-
{{ .ProjectName }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
# use zip for windows archives
format_overrides:
- goos: windows
formats: ['zip']
changelog:
sort: asc
filters:
exclude:
- '^docs:'
- '^test:'
release:
footer: >-
---
Released by [GoReleaser](https://github.com/goreleaser/goreleaser).

4
.vscode/launch.json vendored
View File

@ -9,9 +9,9 @@
"type": "go",
"request": "launch",
"mode": "auto",
"program": "${workspaceFolder}/cmd/q3rcon-proxy/main.go",
"program": "${workspaceFolder}/cmd/q3rcon-proxy/",
"env": {
"Q3RCON_PROXY": "28961:28960",
"Q3RCON_PORTS_MAPPING": "28961:28960",
}
}
]

View File

@ -11,6 +11,50 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- [x]
## [1.7.0] - 2025-06-05
### Added
- Taskfile added for running and building project.
- The binary may be passed CLI flags as well as environment variables.
### Changed
- CLI component rewritten with urfave/cli.
- env var `Q3RCON_TARGET_PORTS` renamed to `Q3RCON_PORTS_MAPPING`
## [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

View File

@ -1,14 +0,0 @@
FROM golang:1.21
WORKDIR /usr/src/app
# pre-copy/cache go.mod for pre-downloading dependencies and only redownloading them in subsequent builds if they change
COPY go.mod go.sum ./
RUN go mod download && go mod verify
# build binary and place into /usr/local/bin/
COPY . .
RUN go build -v -o /usr/local/bin/q3rcon-proxy ./cmd/q3rcon-proxy/
# Command to run when starting the container
ENTRYPOINT [ "q3rcon-proxy" ]

View File

@ -1,2 +1,40 @@
go-build:
go build ./cmd/q3rcon-proxy/
PROGRAM = q3rcon-proxy
GO = @go
BIN_DIR := bin
WINDOWS=$(BIN_DIR)/$(PROGRAM)_windows_amd64.exe
LINUX=$(BIN_DIR)/$(PROGRAM)_linux_amd64
VERSION=$(shell git log -n 1 --format=%h)
.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/$(PROGRAM)/
$(LINUX):
env GOOS=linux GOARCH=amd64 go build -v -o $(LINUX) -ldflags="-s -w -X main.version=$(VERSION)" ./cmd/$(PROGRAM)/
test:
$(GO) test ./...
$(BIN_DIR):
@mkdir -p $@
clean:
@rm -rv $(BIN_DIR)

View File

@ -8,23 +8,52 @@ 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`
for example:
#### Flags
```bash
export Q3RCON_PROXY="20000:28960;20001:28961;20002:28962"
#!/usr/bin/env bash
/usr/local/bin/q3rcon-proxy \
--proxy-host=0.0.0.0 \
--target-host=localhost \
--ports-mapping=28961:28960 \
--session-timeout=20 \
--loglevel=debug
```
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.
#### Environment Variables
Then just run the binary which you can compile yourself, download from `Releases` or use the included Dockerfile.
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_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:
```console
export Q3RCON_PORTS_MAPPING="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.
### Logging
Set the log level with environment variable `Q3RCON_LOGLEVEL`:
Set the log level with environment variable `Q3RCON_LOGLEVEL`.
`0 = Panic, 1 = Fatal, 2 = Error, 3 = Warning, 4 = Info, 5 = Debug, 6 = Trace`
Acceptable values are:
- `trace`
- `debug`
- `info`
- `warn`
- `error`
- `fatal`
- `panic`
If not set it will default to `info`.
### Special Thanks
@ -32,3 +61,10 @@ 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
[logging]: https://github.com/onyx-and-iris/q3rcon-proxy/tree/dev?tab=readme-ov-file#logging

71
Taskfile.yml Normal file
View File

@ -0,0 +1,71 @@
version: '3'
includes:
docker: ./docker/Taskfile.docker.yml
vars:
PROGRAM: q3rcon-proxy
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
BIN_DIR: bin
WINDOWS: '{{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe'
LINUX: '{{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64'
GIT_COMMIT:
sh: git log -n 1 --format=%h
tasks:
default:
desc: Build the q3rcon-proxy project
cmds:
- task: build
build:
desc: Build the q3rcon-proxy project
deps: [vet]
cmds:
- task: build-windows
- task: build-linux
vet:
desc: Vet the code
deps: [fmt]
cmds:
- go vet ./...
fmt:
desc: Fmt the code
cmds:
- go fmt ./...
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}}/
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}}/
internal: true
test:
desc: Run tests
cmds:
- go test ./...
clean:
desc: Clean the build artifacts
cmds:
- '{{.SHELL}} rm -r {{.BIN_DIR}}'
run:
desc: Run the q3rcon-proxy project
cmds:
- |
go run ./cmd/{{.PROGRAM}} \
--proxy-host=0.0.0.0 \
--target-host=localhost \
--ports-mapping=28961:28960 \
--session-timeout=20 \
--loglevel=debug

View File

@ -1,54 +1,132 @@
package main
import (
"context"
"fmt"
"os"
"slices"
"strconv"
"strings"
"time"
udpproxy "github.com/onyx-and-iris/q3rcon-proxy"
log "github.com/sirupsen/logrus"
"github.com/onyx-and-iris/q3rcon-proxy/pkg/udpproxy"
"github.com/urfave/cli/v3"
)
// proxyConfig holds the configuration for a single UDP proxy server.
type proxyConfig struct {
proxyHost string
targetHost string
portsMapping []string
sessionTimeout int
}
func main() {
logLevel, err := getEnvInt("Q3RCON_LOGLEVEL")
if err != nil {
log.Fatalf("unable to parse Q3RCON_LEVEL: %s", err.Error())
}
if slices.Contains(log.AllLevels, log.Level(logLevel)) {
log.SetLevel(log.Level(logLevel))
cmd := &cli.Command{
Name: "q3rcon-proxy",
Usage: "A Quake 3 RCON proxy server",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "proxy-host",
Value: "0.0.0.0",
Usage: "Proxy host address",
Sources: cli.EnvVars("Q3RCON_PROXY_HOST"),
},
&cli.StringFlag{
Name: "target-host",
Value: "localhost",
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"),
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)
}
proxyPort, err := strconv.Atoi(ports[0])
if err != nil || proxyPort < 1 || proxyPort > 65535 {
return fmt.Errorf("invalid proxy port: %s", ports[0])
}
targetPort, err := strconv.Atoi(ports[1])
if err != nil || targetPort < 1 || targetPort > 65535 {
return fmt.Errorf("invalid target port: %s", ports[1])
}
if proxyPort == targetPort {
return fmt.Errorf("proxy and target ports cannot be the same: %s", mapping)
}
}
return nil
},
},
&cli.IntFlag{
Name: "session-timeout",
Value: 20,
Usage: "Session timeout in minutes",
Sources: cli.EnvVars("Q3RCON_SESSION_TIMEOUT"),
},
&cli.StringFlag{
Name: "loglevel",
Value: "info",
Usage: "Log level (trace, debug, info, warn, error, fatal, panic)",
Sources: cli.EnvVars("Q3RCON_LOGLEVEL"),
},
},
Before: func(ctx context.Context, cmd *cli.Command) (context.Context, error) {
logLevel, err := log.ParseLevel(cmd.String("loglevel"))
if err != nil {
return ctx, fmt.Errorf("invalid log level: %w", err)
}
log.SetLevel(logLevel)
return ctx, nil
},
Action: func(_ context.Context, cmd *cli.Command) error {
errChan := make(chan error)
for mapping := range strings.SplitSeq(cmd.String("ports-mapping"), ";") {
cfg := proxyConfig{
proxyHost: cmd.String("proxy-host"),
targetHost: cmd.String("target-host"),
portsMapping: strings.Split(mapping, ":"),
sessionTimeout: cmd.Int("session-timeout"),
}
go launchProxy(cfg, errChan)
}
// Under normal circumstances, the main goroutine will block here.
// If we receive an error we will log it and exit
return <-errChan
},
}
proxies := os.Getenv("Q3RCON_PROXY")
if proxies == "" {
log.Fatal("env Q3RCON_PROXY required")
}
host := os.Getenv("Q3RCON_HOST")
if host == "" {
host = "0.0.0.0"
}
for _, proxy := range strings.Split(proxies, ";") {
go start(host, proxy)
}
<-make(chan int)
log.Fatal(cmd.Run(context.Background(), os.Args))
}
func start(host, proxy string) {
port, target := func() (string, string) {
x := strings.Split(proxy, ":")
return x[0], x[1]
}()
// launchProxy initializes 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]
c, err := udpproxy.New(fmt.Sprintf("%s:%s", host, port), fmt.Sprintf("127.0.0.1:%s", target))
hostAddr := fmt.Sprintf("%s:%s", cfg.proxyHost, proxyPort)
proxyAddr := fmt.Sprintf("%s:%s", cfg.targetHost, targetPort)
server, err := udpproxy.New(
hostAddr, proxyAddr,
udpproxy.WithSessionTimeout(time.Duration(cfg.sessionTimeout)*time.Minute))
if err != nil {
log.Fatal(err)
errChan <- fmt.Errorf("failed to create proxy: %w", err)
return
}
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())
errChan <- server.ListenAndServe()
}

View File

@ -1,18 +0,0 @@
package main
import (
"os"
"strconv"
)
func getEnvInt(key string) (int, error) {
s := os.Getenv(key)
if s == "" {
return 0, nil
}
v, err := strconv.Atoi(s)
if err != nil {
return 0, err
}
return v, nil
}

View File

@ -6,9 +6,9 @@ After=network.target
[Service]
Type=simple
User=gameservers
Environment="Q3RCON_PROXY=20000:28960;20001:28961;20002:28962"
Environment="Q3RCON_PORTS_MAPPING=20000:28960;20001:28961;20002:28962"
Environment="Q3RCON_HOST=0.0.0.0"
Environment="Q3RCON_DEBUG=0"
Environment="Q3RCON_LOGLEVEL=info"
ExecStart=/usr/local/bin/q3rcon-proxy
Restart=always

21
docker/Dockerfile Normal file
View File

@ -0,0 +1,21 @@
FROM golang:1.24 AS build_image
WORKDIR /usr/src/app
# pre-copy/cache go.mod for pre-downloading dependencies and only redownloading them in subsequent builds if they change
COPY go.mod go.sum ./
RUN go mod download && go mod verify
COPY . .
# build binary, place into ./bin/
RUN CGO_ENABLED=0 GOOS=linux go build -o ./bin/q3rcon-proxy ./cmd/q3rcon-proxy/
FROM scratch AS final_image
WORKDIR /bin/
COPY --from=build_image /usr/src/app/bin/q3rcon-proxy .
# Command to run when starting the container
ENTRYPOINT [ "./q3rcon-proxy" ]

View File

@ -0,0 +1,26 @@
version: '3'
vars:
IMAGE: q3rcon-proxy
tasks:
build:
desc: Build the Docker image
cmds:
- docker build -t {{.IMAGE}} -f docker/Dockerfile .
dir: .
login:
desc: Login to Github Container Registry
cmds:
- docker login ghcr.io -u {{.GHCR_USER}} --password-stdin <<< {{.GHCR_TOKEN}}
internal: true
push:
desc: Push the Docker image to Github Container Registry
deps:
- task: build
- task: login
cmds:
- docker tag {{.IMAGE}} ghcr.io/{{.GHCR_USER}}/{{.IMAGE}}:latest
- docker push ghcr.io/{{.GHCR_USER}}/{{.IMAGE}}:latest

11
go.mod
View File

@ -1,7 +1,12 @@
module github.com/onyx-and-iris/q3rcon-proxy
go 1.18
go 1.24.0
require github.com/sirupsen/logrus v1.9.3
toolchain go1.24.1
require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
require (
github.com/sirupsen/logrus v1.9.3
github.com/urfave/cli/v3 v3.3.8
)
require golang.org/x/sys v0.33.0 // indirect

11
go.sum
View File

@ -6,10 +6,15 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/urfave/cli/v3 v3.3.8 h1:BzolUExliMdet9NlJ/u4m5vHSotJ3PzEqSAZ1oPMa/E=
github.com/urfave/cli/v3 v3.3.8/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

22
option.go Normal file
View File

@ -0,0 +1,22 @@
package udpproxy
import (
"time"
log "github.com/sirupsen/logrus"
)
// 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
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")
return
}
c.sessionTimeout = timeout
}
}

41
sessioncache.go Normal file
View File

@ -0,0 +1,41 @@
package udpproxy
import "sync"
// sessionCache tracks connection sessions
type sessionCache struct {
mu sync.RWMutex
data map[string]*session
}
// newSessionCache creates a usable sessionCache.
func newSessionCache() sessionCache {
return sessionCache{
data: make(map[string]*session),
}
}
// read returns the associated session for an addr
func (sc *sessionCache) read(addr string) (*session, bool) {
sc.mu.RLock()
defer sc.mu.RUnlock()
v, ok := sc.data[addr]
return v, ok
}
// insert adds a session for a given addr.
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.
func (sc *sessionCache) delete(addr string) {
sc.mu.Lock()
defer sc.mu.Unlock()
delete(sc.data, addr)
}

View File

@ -2,7 +2,6 @@ package udpproxy
import (
"net"
"sync"
"time"
log "github.com/sirupsen/logrus"
@ -14,12 +13,12 @@ type Client struct {
proxyConn *net.UDPConn
mutex sync.RWMutex
sessions map[string]*session
sessionCache sessionCache
sessionTimeout time.Duration
}
func New(port, target string) (*Client, error) {
laddr, err := net.ResolveUDPAddr("udp", port)
func New(proxy, target string, options ...Option) (*Client, error) {
laddr, err := net.ResolveUDPAddr("udp", proxy)
if err != nil {
return nil, err
}
@ -29,12 +28,18 @@ func New(port, target string) (*Client, error) {
return nil, err
}
return &Client{
laddr: laddr,
raddr: raddr,
mutex: sync.RWMutex{},
sessions: map[string]*session{},
}, nil
c := &Client{
laddr: laddr,
raddr: raddr,
sessionCache: newSessionCache(),
sessionTimeout: 20 * time.Minute,
}
for _, o := range options {
o(c)
}
return c, nil
}
func (c *Client) ListenAndServe() error {
@ -53,7 +58,7 @@ func (c *Client) ListenAndServe() error {
log.Error(err)
}
session, ok := c.sessions[caddr.String()]
session, ok := c.sessionCache.read(caddr.String())
if !ok {
session, err = newSession(caddr, c.raddr, c.proxyConn)
if err != nil {
@ -61,7 +66,7 @@ func (c *Client) ListenAndServe() error {
continue
}
c.sessions[caddr.String()] = session
c.sessionCache.insert(caddr.String(), session)
}
go session.proxyTo(buf[:n])
@ -71,15 +76,12 @@ func (c *Client) ListenAndServe() error {
func (c *Client) pruneSessions() {
ticker := time.NewTicker(1 * time.Minute)
// the locks here could be abusive and i dont even know if this is a real
// problem but we definitely need to clean up stale sessions
for range ticker.C {
for _, session := range c.sessions {
c.mutex.RLock()
if time.Since(session.updateTime) > time.Minute*5 {
delete(c.sessions, session.caddr.String())
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)
}
c.mutex.RUnlock()
}
}
}