make things a bit less ugly

.github/workflows/lint.yml

@@ -0,0 +1,7 @@
+name: ci
+
+on: [push]
+
+jobs:
+  test:
+    uses: byReqz/workflows/.github/workflows/golint_with_codeql.yml@main

README.md

@@ -1,5 +1,5 @@
 # probehost2
-an http endpoint to query network diagnosis tools from remote hosts
+a http endpoint to query network diagnosis tools from remote hosts
 
 - <a href="#probehost2">Overview</a>
 - <a href="#disclaimer">Disclaimer</a>
@@ -15,14 +15,15 @@ an http endpoint to query network diagnosis tools from remote hosts
         - <a href="#ping">Ping</a>
         - <a href="#mtr">MTR</a>
         - <a href="#traceroute">Traceroute</a>
+        - <a href="#nping">Nping</a>
 
 # Disclaimer
-Dont expect good or even mediocre code here. This is my first take at go and is mostly for myself to learn. Suggestions and improvements are welcome.
+Don't expect good or even mediocre code here. This is my first take at go and is mostly for myself to learn. Suggestions and improvements are welcome.
 
 Please note that this project does not include any kind of rate limiting or other protection. It is therefore heavily advised to only make it publicly reachable if a reverse proxy is in place. A sample config for <a href="caddyserver.com/">Caddy</a> can be found in the `caddy` subfolder. 
 
 # Installation
-The runtime dependencies are currently `iputils`, `traceroute` and `mtr` (sometimes called `mtr-tiny`). `iputils` and `traceroute` can be substituted by `busybox`.
+The runtime dependencies are currently `iputils`, `traceroute`, `nping` (usually provided by nmap) and `mtr` (sometimes called `mtr-tiny`). `iputils` and `traceroute` can be substituted by `busybox`.
 
 ## Building
 The app can be built with the latest Go toolchain.
@@ -48,7 +49,7 @@ docker build -f docker/Dockerfile . -t byreqz/probehost2:latest
 A compose file can also be found in `docker/docker-compose.yml`.
 
 ## Proxy
-Its recommended to only run this app together with a rate-limiting reverse-proxy. An example configuration for <a href="caddyserver.com/">Caddy</a> can be found in the `caddy` subfolder. 
+It's recommended to only run this app together with a rate-limiting reverse-proxy. An example configuration for <a href="caddyserver.com/">Caddy</a> can be found in the `caddy` subfolder. 
 
 # Usage
 ## Server
@@ -58,9 +59,9 @@ The app currently has 4 runtime flags:
 - `-x / --disable-x-forwarded-for` -- disables checking for the X-Forwarded-For header
 - `-l / --allow-private` -- allows lookups of private IP ranges
 
-All of the Flags also have an accompanying environment value: `PROBEHOST_LOGPATH`, `PROBEHOST_ALLOW_PRIVATE`, `PROBEHOST_LISTEN_PORT` and `PROBEHOST_DISABLE_X_FORWARDED_FOR` but the options given via commandline have priority.
+All the Flags also have an accompanying environment value: `PROBEHOST_LOGPATH`, `PROBEHOST_ALLOW_PRIVATE`, `PROBEHOST_LISTEN_PORT` and `PROBEHOST_DISABLE_X_FORWARDED_FOR` but the options given via commandline have priority.
 
-The app will log every request including the IP thats querying and show failed requests on stdout.
+The app will log every request including the IP that's querying and show failed requests on stdout.
 
 Requests that contain an X-Forwarded-For header (implying the app is behind a reverse proxy) will automatically log that address instead of the requesting IP (the proxy itself), this can be turned off with -x.
 
@@ -68,7 +69,7 @@ Requests that contain an X-Forwarded-For header (implying the app is behind a re
 ### General
 The app can be queried via HTTP/HTTPS with the following scheme:
 ```
-https://[address]/[command]/[hosts]/[options]
+https://[address]/[command]/[host](_[port]),[host].../[options]
 ```
 
 - [address] = the IP or domain serving the site
@@ -76,7 +77,9 @@ https://[address]/[command]/[hosts]/[options]
   - ping
   - mtr
   - traceroute
-- [hosts] = can be one or more hosts query, seperated by a comma
+  - nping
+- [host] = can be one or more hosts query, seperated by a comma
+- [port] = port to be queried, optional
 - [options] = options to run the command with, seperated by a comma
 
 All inputs are validated and invalid input is discarded. If the request contains no valid data, the server will return HTTP 500.
@@ -131,7 +134,7 @@ Available options are:
 - `c10` / `count10`: send 10 pings
 
 Example query:
-```
+```sh
 $ curl http://localhost:8000/mtr/localhost/c1,z
 Start: 2022-01-02T00:06:56+0100
 HOST: xxx                 Loss%   Snt   Last   Avg  Best  Wrst StDev
@@ -155,9 +158,37 @@ Available options are:
 - `b` / `back`: Guess the number of hops in the backward path and print if it differs
 
 Example query:
-```
+```sh
 $ curl http://localhost:8000/tracert/localhost/i 
 traceroute to localhost (127.0.0.1), 30 hops max, 60 byte packets
  1  localhost (127.0.0.1)  0.063 ms  0.008 ms  0.006 ms
-
+```
+### Nping
+The default options are:
+- `c3`: send 3 pings
+
+Available options are:
+- `4` / `force4`: force IPv4
+- `6` / `force6`: force IPv6
+- `u` / `udp`: use UDP
+- `t` / `tcp`: use TCP
+- `v` / `verbose`: be verbose
+- `c1` / `count1`: send 1 ping
+- `c3` / `count3`: send 3 pings
+- `c5` / `count5`: send 5 pings
+
+Example query:
+```sh
+$ curl localhost:8000/nping/localhost_22
+Starting Nping 0.7.92 ( https://nmap.org/nping ) at 2022-05-29 15:28 CEST
+SENT (0.0022s) Starting TCP Handshake > localhost:22 (127.0.0.1:22)
+RCVD (0.0133s) Handshake with localhost:22 (127.0.0.1:22) completed
+SENT (1.0041s) Starting TCP Handshake > localhost:22 (127.0.0.1:22)
+RCVD (1.0089s) Handshake with localhost:22 (127.0.0.1:22) completed
+SENT (2.0071s) Starting TCP Handshake > localhost:22 (127.0.0.1:22)
+RCVD (2.0090s) Handshake with localhost:22 (127.0.0.1:22) completed
+ 
+Max rtt: 11.130ms | Min rtt: 1.945ms | Avg rtt: 5.965ms
+TCP connection attempts: 3 | Successful connections: 3 | Failed: 0 (0.00%)
+Nping done: 1 IP address pinged in 2.01 seconds
 ```

docker/Dockerfile

@@ -2,11 +2,14 @@ FROM golang:latest as builder
 WORKDIR /build
 COPY . .
 RUN go get -u
-RUN CGO_ENABLED=0 go build -o probehost2
+RUN CGO_ENABLED=0 go build -ldflags="-s -w" -o probehost2
 
 FROM alpine:latest
 RUN apk update
-RUN apk add mtr iputils
+RUN apk add mtr iputils nmap-nping traceroute
+RUN adduser -D probehost2
 COPY --from=builder /build/probehost2 /
 RUN touch /probehost2.log
+RUN chown probehost2:users /probehost2.log
+USER probehost2
 CMD ["/probehost2"]

main.go

@@ -13,78 +13,70 @@ import (
 	flag "github.com/spf13/pflag"
 )
 
-var logstdout = log.New()
-var logfile = log.New()
+var logStdout = log.New()
+var logFile = log.New()
 
-var listenport int
-var disablexforwardedfor bool
-var allowprivate bool
+var listenPort = 8080 // port to listen on
+var disableXForwardedFor bool // whether to disable parsing the X-Forwarded-For header or not
+var allowPrivate bool // whether to allow private IP ranges or not
 
 func init() {
-	logstdout.SetFormatter(&log.TextFormatter{
+	logStdout.SetFormatter(&log.TextFormatter{
 		FullTimestamp: true})
-	logstdout.SetOutput(os.Stdout)
-	logstdout.SetLevel(log.InfoLevel)
-	var logfilepath string
+	logStdout.SetOutput(os.Stdout)
+	logStdout.SetLevel(log.InfoLevel)
 
-	if _, exists := os.LookupEnv("PROBEHOST_LOGPATH"); exists == true {
-		logfilepath, _ = os.LookupEnv("PROBEHOST_LOGPATH")
-	} else {
-		logfilepath = "probehost2.log"
+	logFilePath := "probehost2.log"
+	if val, exists := os.LookupEnv("PROBEHOST_LOGPATH"); exists {
+		logFilePath = val
 	}
-	if exists, _ := os.LookupEnv("PROBEHOST_ALLOW_PRIVATE"); exists == "true" {
-		allowprivate = true
-	} else {
-		allowprivate = false
-	}
-	if envvalue, exists := os.LookupEnv("PROBEHOST_LISTEN_PORT"); exists == true {
+
+	_, allowPrivate = os.LookupEnv("PROBEHOST_ALLOW_PRIVATE")
+	_, disableXForwardedFor = os.LookupEnv("PROBEHOST_DISABLE_X_FORWARDED_FOR")
+
+	if val, exists := os.LookupEnv("PROBEHOST_LISTEN_PORT"); exists {
 		var err error
-		listenport, err = strconv.Atoi(envvalue)
+		listenPort, err = strconv.Atoi(val)
 		if err != nil {
-			logstdout.Fatal("Failed to read PROBEHOST_LISTEN_PORT: ", err.Error())
+			logStdout.Fatal("Failed to read PROBEHOST_LISTEN_PORT: ", err.Error())
 		}
-	} else {
-		listenport = 8000
 	}
-	if exists, _ := os.LookupEnv("PROBEHOST_DISABLE_X_FORWARDED_FOR"); exists == "true" {
-		disablexforwardedfor = true
-	} else {
-		disablexforwardedfor = false
-	}
-	flag.StringVarP(&logfilepath, "logfilepath", "o", logfilepath, "sets the output file for the log")
-	flag.IntVarP(&listenport, "port", "p", listenport, "sets the port to listen on")
-	flag.BoolVarP(&disablexforwardedfor, "disable-x-forwarded-for", "x", disablexforwardedfor, "whether to show x-forwarded-for or the requesting IP")
-	flag.BoolVarP(&allowprivate, "allow-private", "l", allowprivate, "whether to show lookups of private IP ranges")
+
+	flag.StringVarP(&logFilePath, "logFilePath", "o", logFilePath, "sets the output file for the log")
+	flag.IntVarP(&listenPort, "port", "p", listenPort, "sets the port to listen on")
+	flag.BoolVarP(&disableXForwardedFor, "disable-x-forwarded-for", "x", disableXForwardedFor, "whether to show x-forwarded-for or the requesting IP")
+	flag.BoolVarP(&allowPrivate, "allow-private", "l", allowPrivate, "whether to show lookups of private IP ranges")
 	flag.Parse()
 
-	logpath, err := os.OpenFile(logfilepath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0660)
+	logpath, err := os.OpenFile(logFilePath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0660)
 	if err != nil {
-		logstdout.Fatal("Failed to initialize the logfile: ", err.Error())
+		logStdout.Fatal("Failed to initialize the logFile: ", err.Error())
 	}
-	logfile.SetLevel(log.InfoLevel)
-	logfile.SetOutput(logpath)
-	logfile.Info("probehost2 initialized")
+	logFile.SetLevel(log.InfoLevel)
+	logFile.SetOutput(logpath)
+	logFile.Info("probehost2 initialized")
 }
 
+// runner runs the given command with the given args and returns stdout as string. Also logs all executed commands and their exit state.
 func runner(remoteip string, command string, args ...string) string {
-	logfile.WithFields(log.Fields{
+	logFile.WithFields(log.Fields{
 		"remote_ip": remoteip,
 		"command":   fmt.Sprint(command, args),
 	}).Info("request initiated:")
 	cmd, err := exec.Command(command, args...).Output()
 	if err != nil {
-		logstdout.WithFields(log.Fields{
+		logStdout.WithFields(log.Fields{
 			"remote_ip": remoteip,
 			"command":   fmt.Sprint(command, args),
 			"error":     err.Error(),
 		}).Warn("request failed:")
-		logfile.WithFields(log.Fields{
+		logFile.WithFields(log.Fields{
 			"remote_ip": remoteip,
 			"command":   fmt.Sprint(command, args),
 			"error":     err.Error(),
 		}).Warn("request failed:")
 	} else {
-		logfile.WithFields(log.Fields{
+		logFile.WithFields(log.Fields{
 			"remote_ip": remoteip,
 			"command":   fmt.Sprint(command, args),
 		}).Info("request succeeded:")
@@ -92,20 +84,21 @@ func runner(remoteip string, command string, args ...string) string {
 	return string(cmd)
 }
 
+// validatehosts checks the given host+port combinations for validity and returns valid hosts + valid ports seperately.
 func validatehosts(hosts []string) ([]string, []string) {
-	var validhosts []string
-	var validports []string
+	var validHosts []string
+	var validPorts []string
 	for _, host := range hosts {
 		split := strings.Split(host, "_")
 		host = split[0]
 		if hostparse := net.ParseIP(host); hostparse != nil {
-			if (net.IP.IsPrivate(hostparse) || net.IP.IsLoopback(hostparse)) && allowprivate {
-				validhosts = append(validhosts, host)
+			if (net.IP.IsPrivate(hostparse) || net.IP.IsLoopback(hostparse)) && allowPrivate {
+				validHosts = append(validHosts, host)
 			} else if !(net.IP.IsPrivate(hostparse) || net.IP.IsLoopback(hostparse)) {
-				validhosts = append(validhosts, host)
+				validHosts = append(validHosts, host)
 			}
 		} else if _, err := net.LookupIP(host); err == nil {
-			validhosts = append(validhosts, host)
+			validHosts = append(validHosts, host)
 		} else {
 			continue
 		}
@@ -115,17 +108,18 @@ func validatehosts(hosts []string) ([]string, []string) {
 			port = split[1]
 			_, err := strconv.Atoi(port) // validate if port is just an int
 			if err == nil {
-				validports = append(validports, port)
+				validPorts = append(validPorts, port)
 			} else {
-				validports = append(validports, "0")
+				validPorts = append(validPorts, "0")
 			}
 		} else {
-			validports = append(validports, "0")
+			validPorts = append(validPorts, "0")
 		}
 	}
-	return validhosts, validports
+	return validHosts, validPorts
 }
 
+// parseopts matches the given user options to the valid optionmap.
 func parseopts(options []string, cmdopts map[string]string) []string {
 	var opts []string
 	for _, opt := range options {
@@ -134,6 +128,7 @@ func parseopts(options []string, cmdopts map[string]string) []string {
 	return opts
 }
 
+// prerunner processes the incoming request to send it to runner.
 func prerunner(req *http.Request, cmd string, cmdopts map[string]string, defaultopts []string) string {
 	geturl := strings.Split(req.URL.String(), "/")
 	targets := strings.Split(geturl[2], ",")
@@ -146,11 +141,9 @@ func prerunner(req *http.Request, cmd string, cmdopts map[string]string, default
 	}
 	var res string
 	var args []string
-	var remoteaddr string
-	if req.Header.Get("X-Forwarded-For") != "" && disablexforwardedfor != true {
+	remoteaddr := req.RemoteAddr
+	if req.Header.Get("X-Forwarded-For") != "" && !disableXForwardedFor {
 		remoteaddr = req.Header.Get("X-Forwarded-For")
-	} else {
-		remoteaddr = req.RemoteAddr
 	}
 	for i, host := range hosts {
 		runargs := append(args, opts...)
@@ -163,6 +156,7 @@ func prerunner(req *http.Request, cmd string, cmdopts map[string]string, default
 	return res
 }
 
+// ping is the response handler for the ping command. It defines the allowed options.
 func ping(w http.ResponseWriter, req *http.Request) {
 	cmd := "ping"
 	cmdopts := map[string]string{
@@ -179,6 +173,7 @@ func ping(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
+// mtr is the response handler for the mtr command. It defines the allowed options.
 func mtr(w http.ResponseWriter, req *http.Request) {
 	cmd := "mtr"
 	cmdopts := map[string]string{
@@ -195,6 +190,7 @@ func mtr(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
+// traceroute is the response handler for the traceroute command. It defines the allowed options.
 func traceroute(w http.ResponseWriter, req *http.Request) {
 	cmd := "traceroute"
 	cmdopts := map[string]string{
@@ -211,6 +207,7 @@ func traceroute(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
+// nping is the response handler for the nping command. It defines the allowed options.
 func nping(w http.ResponseWriter, req *http.Request) {
 	cmd := "nping"
 	cmdopts := map[string]string{
@@ -233,7 +230,7 @@ func main() {
 	http.HandleFunc("/tracert/", traceroute)
 	http.HandleFunc("/traceroute/", traceroute)
 	http.HandleFunc("/nping/", nping)
-	logstdout.Info("Serving on :", listenport)
-	logfile.Info("Serving on :", listenport)
-	_ = http.ListenAndServe(fmt.Sprint(":", listenport), nil)
+	logStdout.Info("Serving on :", listenPort)
+	logFile.Info("Serving on :", listenPort)
+	_ = http.ListenAndServe(fmt.Sprint(":", listenPort), nil)
 }

systemd/probehost2.service

@@ -8,6 +8,8 @@ StartLimitBurst=5
 StartLimitIntervalSec=20
 
 [Service]
+User=1000
+Group=1000
 Restart=always
 RestartSec=1
 ExecStart=/bin/probehost2 --logfilepath "/var/log/probehost2.log" --port 8000