use config file instead of arguments

Author: jackcvr

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 *.log
 dist/
+*.dev.toml

.goreleaser.yaml

@@ -59,11 +59,18 @@ nfpms:
       - apk
       - deb
     contents:
+      - src: reverssh.toml
+        dst: /etc/reverssh/reverssh.toml
+        type: config|noreplace
+        packager: apk
       - src: openrc/reverssh
         dst: /etc/init.d/reverssh
-        type: config|noreplace
         packager: apk
+
+      - src: reverssh.toml
+        dst: /etc/reverssh/reverssh.toml
+        type: config|noreplace
+        packager: deb
       - src: systemd/reverssh.service
         dst: /lib/systemd/system/reverssh.service
-        type: config|noreplace
         packager: deb

README.md

@@ -3,7 +3,7 @@
 Reversing SSH Tarpit.
 
 This tool makes SSH bots brute-force themselves. 
-By using argument `-p` you can specify port numbers (e.g., `-p 22,2222`) to instruct 
+By using key `remoteports` in the config you can specify port numbers to instruct 
 `reverssh` attempt connections on each of the specified ports of the SSH client. 
 If any connection is successful, it forwards all incoming traffic back to the open port, 
 causing bots to interact with their own servers.
@@ -12,9 +12,9 @@ If no ports are specified, or if all provided ports are closed, `reverssh` behav
 sending one random byte per second.
 
 Other features:
-- linux packages(apk, deb) include services(openrc, systemd) which you might want to adjust
-- argument `-b` can be provided few times to listen on few addresses
+- linux packages(apk, deb) include services(openrc, systemd)
 - JSON structured logs
+- ability to bind to few addresses
 - ability to watch active connections
 
 ## Installation
@@ -27,23 +27,25 @@ See [Releases](https://github.com/jackcvr/reverssh/releases)
 Usage of reverssh:
   -active
     	Show active connections info
-  -b value
-    	Local address to listen on
-  -f string
-    	Log file (default stdout)
-  -p value
-    	Remote ports to connect to, e.g. '22,2222'
-  -q	Do not print anything
-  -v	Verbose mode
+  -c string
+    	Path to TOML config file (default "/etc/reverssh/reverssh.toml")
+```
+
+### reverssh.toml sample
+```toml
+tz = "Europe/Vilnius"
+verbose = false
+quiet = false
+bind = ["0.0.0.0:22"]
+remoteports = [22]
 ```
 
 ## Examples
 
-Start reversing tarpit on 2222 and 2223 ports (redirecting clients back to 22 port):
+Start reversing tarpit on 2222 port (redirecting clients back to 22 port):
 
 ```shell
-$ sudo reverssh -b 0.0.0.0:2222 -b 0.0.0.0:2223 -p 22
-{"time":"2024-09-18T15:17:08.854818805+03:00","level":"INFO","msg":"listening","addr":"0.0.0.0:2223"}
+$ sudo reverssh -c reverssh.toml
 {"time":"2024-09-18T15:17:08.854929365+03:00","level":"INFO","msg":"listening","addr":"0.0.0.0:2222"}
 {"time":"2024-09-18T15:17:08.854953224+03:00","level":"INFO","msg":"listening","addr":"/var/run/reverssh.sock"}
 {"time":"2024-09-18T15:17:13.053926647+03:00","level":"INFO","msg":"accepted","laddr":{"IP":"127.0.0.1","Port":2222,"Zone":""},"raddr":{"IP":"127.0.0.1","Port":60988,"Zone":""}}
@@ -56,16 +58,6 @@ $ sudo reverssh -b 0.0.0.0:2222 -b 0.0.0.0:2223 -p 22
 {"time":"2024-09-18T15:17:19.239013755+03:00","level":"INFO","msg":"closed","laddr":{"IP":"127.0.0.1","Port":2223,"Zone":""},"raddr":{"IP":"127.0.0.1","Port":60370,"Zone":""},"lifetime":2,"reversed":true}
 ```
 
-Start normal tarpit on 2222 port:
-
-```shell
-$ sudo reverssh -b 0.0.0.0:2222
-{"time":"2024-09-18T15:17:56.23333367+03:00","level":"INFO","msg":"listening","addr":"0.0.0.0:2222"}
-{"time":"2024-09-18T15:17:56.233464484+03:00","level":"INFO","msg":"listening","addr":"/var/run/reverssh.sock"}
-{"time":"2024-09-18T15:17:57.933792016+03:00","level":"INFO","msg":"accepted","laddr":{"IP":"127.0.0.1","Port":2222,"Zone":""},"raddr":{"IP":"127.0.0.1","Port":53866,"Zone":""}}
-{"time":"2024-09-18T15:18:04.937012135+03:00","level":"INFO","msg":"closed","laddr":{"IP":"127.0.0.1","Port":2222,"Zone":""},"raddr":{"IP":"127.0.0.1","Port":53866,"Zone":""},"lifetime":6,"reversed":false}
-```
-
 Show current activity:
 
 ```shell

app.go

@@ -12,31 +12,29 @@ import (
 )
 
 type App struct {
-	quiet       bool
-	bindAddress StringList
-	remotePorts Ports
+	config Config
 }
 
 func (app App) Error(format string, args ...any) {
-	if !app.quiet {
+	if !app.config.Quiet {
 		fmt.Fprintf(os.Stderr, format+"\n", args...)
 	}
 }
 
 func (app App) LogInfo(format string, args ...any) {
-	if !app.quiet {
+	if !app.config.Quiet {
 		slog.Info(format, args...)
 	}
 }
 
 func (app App) LogDebug(format string, args ...any) {
-	if !app.quiet {
+	if !app.config.Quiet {
 		slog.Debug(format, args...)
 	}
 }
 
 func (app App) LogError(format string, args ...any) {
-	if !app.quiet {
+	if !app.config.Quiet {
 		slog.Error(format, args...)
 	}
 }
@@ -46,18 +44,18 @@ func (app App) Run() error {
 	stats := Stats{}
 	go stats.RunServer(ctx)
 
-	if len(app.bindAddress) > 1 {
+	if len(app.config.Bind) > 1 {
 		var g *errgroup.Group
 		g, ctx = errgroup.WithContext(ctx)
-		for _, addr := range app.bindAddress {
+		for _, addr := range app.config.Bind {
 			g.Go(func() error {
 				return app.Listen(ctx, addr, stats)
 			})
 		}
 		return g.Wait()
 	}
 
-	return app.Listen(ctx, app.bindAddress[0], stats)
+	return app.Listen(ctx, app.config.Bind[0], stats)
 }
 
 func (app App) Listen(ctx context.Context, addr string, stats Stats) error {
@@ -110,7 +108,7 @@ func (app App) HandleConnection(localConn net.Conn, info *ConnInfo) {
 			"reversed", info.IsReversed)
 	}()
 
-	for _, port := range app.remotePorts {
+	for _, port := range app.config.RemotePorts {
 		if err := app.ConnectRemote(localConn, port, info); err != nil {
 			app.LogDebug("error", "reason", err.Error())
 		} else {

go.mod

@@ -3,3 +3,5 @@ module github.com/jackcvr/reverssh
 go 1.23.0
 
 require golang.org/x/sync v0.8.0
+
+require github.com/pelletier/go-toml/v2 v2.2.3

go.sum

@@ -1,2 +1,12 @@
+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/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M=
+github.com/pelletier/go-toml/v2 v2.2.3/go.mod h1:MfCQTFTvCcUyyvvwm1+G6H/jORL20Xlb6rzQu9GuUkc=
+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/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
 golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

main.go

@@ -3,71 +3,78 @@ package main
 import (
 	"flag"
 	"fmt"
+	"github.com/pelletier/go-toml/v2"
 	"io"
 	"log"
 	"log/slog"
 	"os"
 	"runtime/debug"
+	"time"
+	_ "time/tzdata"
 )
 
+var configPath = "/etc/reverssh/reverssh.toml"
+
+type Config struct {
+	TZ          string
+	Verbose     bool
+	Quiet       bool
+	Bind        []string
+	RemotePorts []int
+}
+
+var config = Config{
+	TZ:          "Europe/Vilnius",
+	Verbose:     false,
+	Quiet:       false,
+	Bind:        []string{"0.0.0.0:22"},
+	RemotePorts: []int{22},
+}
+
 func init() {
 	debug.SetGCPercent(25)
 	flag.CommandLine.SetOutput(os.Stderr)
 }
 
 func main() {
-	var verbose bool
-	var logFile string
 	var showActive bool
-	var app App
 
-	flag.BoolVar(&verbose, "v", false, "Verbose mode")
-	flag.StringVar(&logFile, "f", "", "Log file (default stdout)")
+	flag.StringVar(&configPath, "c", configPath, "Path to TOML config file")
 	flag.BoolVar(&showActive, "active", false, "Show active connections info")
-	flag.BoolVar(&app.quiet, "q", false, "Do not print anything")
-	flag.Var(&app.bindAddress, "b", "Local address to listen on")
-	flag.Var(&app.remotePorts, "p", "Remote ports to connect to, e.g. '22,2222'")
 	flag.Parse()
 
-	if len(app.bindAddress) == 0 {
-		app.bindAddress = StringList{"0.0.0.0:22"}
-	}
-
 	if showActive {
 		data, err := ReadStats()
 		if err != nil && err != io.EOF {
-			app.Error(err.Error())
+			panic(err)
 		} else {
 			fmt.Print(string(data))
 		}
 		return
 	}
 
+	if data, err := os.ReadFile(configPath); err != nil {
+		panic(err)
+	} else if err = toml.Unmarshal(data, &config); err != nil {
+		panic(err)
+	}
+
+	if loc, err := time.LoadLocation(config.TZ); err != nil {
+		panic(err)
+	} else {
+		time.Local = loc
+	}
+
 	log.SetFlags(log.LstdFlags | log.Lmicroseconds)
 	level := slog.LevelInfo
-	if verbose {
+	if config.Verbose {
 		level = slog.LevelDebug
 	}
-	logger, err := NewLogger(logFile, level)
-	if err != nil {
-		app.Error(err.Error())
-		return
-	}
+	logger := slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{Level: level}))
 	slog.SetDefault(logger)
 
-	if err = app.Run(); err != nil {
+	app := App{config: config}
+	if err := app.Run(); err != nil {
 		app.Error(err.Error())
 	}
 }
-
-func NewLogger(file string, level slog.Level) (*slog.Logger, error) {
-	w := os.Stdout
-	if file != "" {
-		var err error
-		w, err = os.OpenFile(file, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
-		if err != nil {
-			return nil, err
-		}
-	}
-	return slog.New(slog.NewJSONHandler(w, &slog.HandlerOptions{Level: level})), nil
-}

openrc/reverssh

@@ -2,9 +2,13 @@
 
 supervisor=supervise-daemon
 
-command="/usr/local/bin/reverssh"
-command_args="-b 0.0.0.0:22 -p 22,2222 -f /var/log/reverssh.log"
 description="Reversing SSH tarpit"
+command="/usr/local/bin/reverssh"
+command_args="-c /etc/reverssh/reverssh.toml"
+command_background=true
+pidfile="/run/${RC_SVCNAME}.pid"
+output_log="/var/log/${RC_SVCNAME}.log"
+error_log="/var/log/${RC_SVCNAME}.log"
 
 depend() {
 	need net

reverssh.toml

@@ -0,0 +1,5 @@
+tz = "Europe/Vilnius"
+verbose = false
+quiet = false
+bind = ["0.0.0.0:22"]
+remoteports = [22]

systemd/reverssh.service

@@ -3,7 +3,7 @@ Description=Reversing SSH tarpit
 After=network.target
 
 [Service]
-ExecStart=/usr/local/bin/reverssh -b 0.0.0.0:22 -p 22,2222
+ExecStart=/usr/local/bin/reverssh -c /etc/reverssh/reverssh.toml
 Restart=always
 
 [Install]