README.md

@@ -1,161 +1,11 @@
 # probehost2
 an http endpoint to query network diagnosis tools from remote hosts
 
-- <a href="#probehost2">Overview</a>
-- <a href="#disclaimer">Disclaimer</a>
-- <a href="#installation">Installation</a>
-    - <a href="#building">Building</a>
-    - <a href="#systemd">Systemd</a>
-    - <a href="#docker">Docker</a>
-    - <a href="#proxy">Proxy</a>
-- <a href="#usage">Usage</a>
-    - <a href="#server">Server</a>
-    - <a href="#client">Client</a>
-        - <a href="#general">General</a>
-        - <a href="#ping">Ping</a>
-        - <a href="#mtr">MTR</a>
-        - <a href="#traceroute">Traceroute</a>
-
-# Disclaimer
+# 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.
 
-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
+wip
 
-# Installation
-The runtime dependencies are currently `iputils`, `traceroute` 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.
-
-First get the external module dependencies:
-```sh
-go get -u
-```
-Then build the app, this already strips debug symbols. 
-```sh
-go build -ldflags "-s -w" -o "probehost2" main.go
-```
-(if this is unwanted, just leave out the ldflags argument)
-
-## Systemd
-Example files for a systemd service can be found in the `systemd` subfolder.
-
-## Docker
-A docker container based on <a href="https://alpinelinux.org">Alpine</a> can be built by using the included dockerfile (`docker/Dockerfile`).
-```sh
-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. 
-
-# Usage
-## Server
-The app currently has 4 runtime flags:
-- `-p / --listenport` -- sets the port to listen on
-- `-o / --logfilepath` -- sets the log output file
-- `-x / --disable-x-forwarded-for` -- disables checking for the X-Forwarded-For header
-- `-l / --allow-private` -- allows lookups of private IP ranges
-
-The app will log every request including the IP thats 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.
-
-## Client
-### General
-The app can be queried via HTTP/HTTPS with the following scheme:
-```
-https://[address]/[command]/[hosts]/[options]
-```
-
-- [address] = the IP or domain serving the site
-- [command] = the command to return, currently available:
-  - ping
-  - mtr
-  - traceroute
-- [hosts] = can be one or more hosts query, seperated by a comma
-- [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.
-
-Local IP ranges are by default excluded from lookups, this currently only includes IPs and not hostnames and can be disabled on the server by passing the -l flag.
-
-Command options are based on the originally given cli flags but also have a more understandable altname.
-
-### Ping
-The default options are:
-- `-c 10`: send 10 pings
-
-Available options are:
-- `4` / `force4`: force IPv4
-- `6` / `force6`: force IPv6
-- `d` / `timestamps`: print timestamps
-- `n` / `nodns`: no dns name resolution
-- `v` / `verbose`: verbose output
-- `c1` / `count1`: send 1 ping
-- `c5` / `count5`: send 5 pings
-- `c10` / `count10`: send 10 pings
-
-Example query:
-```sh
-$ curl http://localhost:8000/ping/localhost/c1
-PING localhost(localhost (::1)) 56 data bytes
-64 bytes from localhost (::1): icmp_seq=1 ttl=64 time=0.189 ms
-
---- localhost ping statistics ---
-1 packets transmitted, 1 received, 0% packet loss, time 0ms
-rtt min/avg/max/mdev = 0.189/0.189/0.189/0.000 ms
-```
-
-### MTR
-The default options are:
-- `-r`: output using report mode
-- `-w`: output wide report
-- `-c10`: send 10 pings
-
-Available options are:
-- `4` / `force4`: force IPv4
-- `6` / `force6`: force IPv6
-- `u` / `udp`: use UDP instead of ICMP echo
-- `t` / `tcp`: use TCP instead of ICMP echo
-- `e` / `ext`: display information from ICMP extensions
-- `x` / `xml`: output xml
-- `n` / `nodns`: do not resolve host names
-- `b` / `cmb`: show IP numbers and host names
-- `z` / `asn`: display AS number
-- `c1` / `count1`: send 1 ping
-- `c5` / `count5`: send 5 pings
-- `c10` / `count10`: send 10 pings
-
-Example query:
-```
-$ curl http://localhost:8000/mtr/localhost/c1,z
-Start: 2022-01-02T00:06:56+0100
-HOST: xxx                 Loss%   Snt   Last   Avg  Best  Wrst StDev
-  1. AS???    localhost   0.0%     1    0.6   0.6   0.6   0.6   0.0
-```
-
-### Traceroute
-The default options are:
-- none
-
-Available options are:
-- `4` / `force4`: force IPv4
-- `6` / `force6`: force IPv6
-- `f` / `dnf`: do not fragment packets
-- `i` / `ìcmp`: use ICMP ECHO for tracerouting
-- `t` / `tcp`: use TCP SYN for tracerouting (default port is 80)
-- `n` / `nodns`: do not resolve IP addresses to their domain names
-- `u` / `udp`: use UDP to particular port for tracerouting (default port is 53)
-- `ul` / `udplite`: Use UDPLITE for tracerouting (default port is 53)
-- `d` / `dccp`: Use DCCP Request for tracerouting (default port is 33434)
-- `b` / `back`: Guess the number of hops in the backward path and print if it differs
-
-Example query:
-```
-$ 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
-
-```
+# doc
+wip

docker/Dockerfile

@@ -6,7 +6,7 @@ RUN CGO_ENABLED=0 go build -o probehost2
 
 FROM alpine:latest
 RUN apk update
-RUN apk add mtr iputils
+RUN apk add mtr
 COPY --from=builder /build/probehost2 /
 RUN touch /probehost2.log
 CMD ["/probehost2"]

main.go

@@ -16,15 +16,13 @@ var logstdout = log.New()
 var logfile = log.New()
 
 var listenport int
-var disablexforwardedfor bool
-var allowprivate bool
+var usexforwardedfor bool
 
 func init() {
   var logfilepath string
   flag.StringVarP(&logfilepath, "logfilepath", "o","probehost2.log", "sets the output file for the log")
   flag.IntVarP(&listenport, "port", "p", 8000, "sets the port to listen on")
-  flag.BoolVarP(&disablexforwardedfor, "disable-x-forwarded-for", "x", false, "whether to show x-forwarded-for or the requesting IP")
-  flag.BoolVarP(&allowprivate, "allow-private", "l", false, "whether to show lookups of private IP ranges")
+  flag.BoolVarP(&usexforwardedfor, "use-x-forwarded-for", "x", true, "specifies whether to show x-forwarded-for or the requesting IP")
   flag.Parse()
 
   logstdout.SetFormatter(&log.TextFormatter{
@@ -70,12 +68,8 @@ func runner(remoteip string, command string, args... string) string{
 func validatehosts(hosts []string) []string{
   var valid []string
   for _, host := range hosts {
-    if hostparse := net.ParseIP(host); hostparse != nil {
-      if (net.IP.IsPrivate(hostparse) || net.IP.IsLoopback(hostparse)) && allowprivate {
-        valid = append(valid, host)
-      } else if ! (net.IP.IsPrivate(hostparse) || net.IP.IsLoopback(hostparse)) {
-        valid = append(valid, host)
-      }
+    if net.ParseIP(host) != nil {
+      valid = append(valid, host)
     } else if _, err := net.LookupIP(host); err == nil {
       valid = append(valid, host)
     }
@@ -104,7 +98,7 @@ 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 {
+  if req.Header.Get("X-Forwarded-For") != "" && usexforwardedfor != false {
     remoteaddr = req.Header.Get("X-Forwarded-For")
   } else {
     remoteaddr = req.RemoteAddr
@@ -119,10 +113,7 @@ func prerunner(req *http.Request, cmd string, cmdopts map[string]string, default
 
 func ping(w http.ResponseWriter, req *http.Request) {
   cmd := "ping"
-  cmdopts := map[string]string{
-    "4": "-4", "6": "-6", "d": "-D", "n": "-n", "v": "-v", "c1": "-c1", "c5": "-c5", "c10": "-c10",
-    "force4": "-4", "force6": "-6", "timestamps": "-D", "nodns": "-n", "verbose": "-v", "count1": "-c1", "count5": "-c5", "count10": "-c10",
-  }
+  cmdopts := map[string]string{"4": "-4", "6": "-6", "d": "-D", "n": "-n", "v": "-v", "c1": "-c1", "c5": "-c5", "c10": "-c10"}
   var defaultopts []string
   defaultopts = append(defaultopts, "-c10")
   res := prerunner(req, cmd, cmdopts, defaultopts)
@@ -135,10 +126,7 @@ func ping(w http.ResponseWriter, req *http.Request) {
 
 func mtr(w http.ResponseWriter, req *http.Request) {
   cmd := "mtr"
-  cmdopts := map[string]string{
-    "4": "-4", "6": "-6", "u": "-u", "t": "-T", "e": "-e", "x": "-x", "n": "-n", "b": "-b", "z": "-z", "c1": "-c1", "c5": "-c5", "c10": "-c10",
-    "force4": "-4", "force6": "-6", "udp": "-u", "tcp": "-T", "ext": "-e", "xml": "-x", "nodns": "-n", "cmb": "-b", "asn": "-z", "count1": "-c1", "count5": "-c5", "count10": "-c10",
-  }
+  cmdopts := map[string]string{"4": "-4", "6": "-6", "u": "-u", "t": "-T", "e": "-e", "x": "-x", "n": "-n", "b": "-b", "z": "-z", "c1": "-c1", "c5": "-c5", "c10": "-c10"}
   var defaultopts []string
   defaultopts = append(defaultopts, "-r", "-w", "-c10")
   res := prerunner(req, cmd, cmdopts, defaultopts)
@@ -151,10 +139,7 @@ func mtr(w http.ResponseWriter, req *http.Request) {
 
 func traceroute(w http.ResponseWriter, req *http.Request) {
   cmd := "traceroute"
-  cmdopts := map[string]string{
-    "4": "-4", "6": "-6", "f": "-F", "i": "-I", "t": "-T", "n": "-n", "u": "-U", "ul": "-UL", "d": "-D", "b": "--back",
-    "force4": "-4", "force6": "-6", "dnf": "-F", "icmp": "-I", "tcp": "-T", "nodns": "-n", "udp": "-U", "udplite": "-UL", "dccp": "-D", "back": "--back",
-  }
+  cmdopts := map[string]string{"4": "-4", "6": "-6", "dnf": "-F", "i": "-I", "t": "-T", "n": "-n", "u": "-U", "ul": "-UL", "d": "-D", "b": "--back"}
   var defaultopts []string
   //defaultopts = append(defaultopts) // no default options for traceroute
   res := prerunner(req, cmd, cmdopts, defaultopts)