Compare commits

..

No commits in common. "2866c9915d8cbd2a912de766318192035b18354c" and "a94503ba7a6c201f12f22748b2fa025369e885d1" have entirely different histories.

3 changed files with 177 additions and 245 deletions

View File

@ -1,5 +1,5 @@
# probehost2
a http endpoint to query network diagnosis tools from remote hosts
an http endpoint to query network diagnosis tools from remote hosts
- <a href="#probehost2">Overview</a>
- <a href="#disclaimer">Disclaimer</a>
@ -15,15 +15,14 @@ a 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
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.
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
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`.
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.
@ -49,7 +48,7 @@ docker build -f docker/Dockerfile . -t byreqz/probehost2:latest
A compose file can also be found in `docker/docker-compose.yml`.
## Proxy
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.
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
@ -59,9 +58,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 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 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.
The app will log every request including the IP that's querying and show failed requests on stdout.
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.
@ -69,7 +68,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]/[host](_[port]),[host].../[options]
https://[address]/[command]/[hosts]/[options]
```
- [address] = the IP or domain serving the site
@ -77,8 +76,7 @@ https://[address]/[command]/[host](_[port]),[host].../[options]
- ping
- mtr
- traceroute
- [host] = can be one or more hosts query, seperated by a comma
- [port] = port to be queried, optional
- [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.
@ -133,7 +131,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
@ -157,37 +155,9 @@ 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
```

View File

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

82
main.go
View File

@ -1,16 +1,16 @@
package main
import (
"fmt"
"net"
"net/http"
"os"
"os/exec"
"strconv"
"strings"
"net/http"
"net"
"strconv"
log "github.com/sirupsen/logrus"
flag "github.com/spf13/pflag"
)
var logstdout = log.New()
@ -92,38 +92,20 @@ func runner(remoteip string, command string, args ...string) string {
return string(cmd)
}
func validatehosts(hosts []string) ([]string, []string) {
var validhosts []string
var validports []string
func validatehosts(hosts []string) []string{
var valid []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)
valid = append(valid, host)
} else if ! (net.IP.IsPrivate(hostparse) || net.IP.IsLoopback(hostparse)) {
validhosts = append(validhosts, host)
valid = append(valid, host)
}
} else if _, err := net.LookupIP(host); err == nil {
validhosts = append(validhosts, host)
} else {
continue
}
var port string
if len(split) > 1 {
port = split[1]
_, err := strconv.Atoi(port) // validate if port is just an int
if err == nil {
validports = append(validports, port)
} else {
validports = append(validports, "0")
}
} else {
validports = append(validports, "0")
valid = append(valid, host)
}
}
return validhosts, validports
return valid
}
func parseopts(options []string, cmdopts map[string]string) []string{
@ -137,7 +119,7 @@ func parseopts(options []string, cmdopts map[string]string) []string {
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], ",")
hosts, ports := validatehosts(targets)
hosts := validatehosts(targets)
var opts []string
opts = append(opts, defaultopts...)
if len(geturl) > 3 && len(geturl[3]) > 0 {
@ -152,13 +134,10 @@ func prerunner(req *http.Request, cmd string, cmdopts map[string]string, default
} else {
remoteaddr = req.RemoteAddr
}
for i, host := range hosts {
runargs := append(args, opts...)
if ports[i] != "0" && cmd == "nping" {
runargs = append(runargs, "-p"+ports[i])
}
runargs = append(runargs, host)
res = fmt.Sprint(res, runner(remoteaddr, cmd, runargs...), "\n")
for _, host := range hosts {
args = append(args, opts...)
args = append(args, host)
res = fmt.Sprint(res, runner(remoteaddr, cmd, args...), "\n")
}
return res
}
@ -173,9 +152,9 @@ func ping(w http.ResponseWriter, req *http.Request) {
defaultopts = append(defaultopts, "-c10")
res := prerunner(req, cmd, cmdopts, defaultopts)
if strings.TrimSpace(res) == "" {
http.Error(w, "500: Internal Server Error", http.StatusInternalServerError)
fmt.Fprintln(w, http.StatusInternalServerError)
} else {
_, _ = fmt.Fprint(w, strings.TrimSpace(res), "\n")
fmt.Fprint(w, strings.TrimSpace(res), "\n")
}
}
@ -189,9 +168,9 @@ func mtr(w http.ResponseWriter, req *http.Request) {
defaultopts = append(defaultopts, "-r", "-w", "-c10")
res := prerunner(req, cmd, cmdopts, defaultopts)
if strings.TrimSpace(res) == "" {
http.Error(w, "500: Internal Server Error", http.StatusInternalServerError)
fmt.Fprintln(w, http.StatusInternalServerError)
} else {
_, _ = fmt.Fprint(w, strings.TrimSpace(res), "\n")
fmt.Fprint(w, strings.TrimSpace(res), "\n")
}
}
@ -205,25 +184,9 @@ func traceroute(w http.ResponseWriter, req *http.Request) {
//defaultopts = append(defaultopts) // no default options for traceroute
res := prerunner(req, cmd, cmdopts, defaultopts)
if strings.TrimSpace(res) == "" {
http.Error(w, "500: Internal Server Error", http.StatusInternalServerError)
fmt.Fprintln(w, http.StatusInternalServerError)
} else {
_, _ = fmt.Fprint(w, strings.TrimSpace(res), "\n")
}
}
func nping(w http.ResponseWriter, req *http.Request) {
cmd := "nping"
cmdopts := map[string]string{
"4": "-4", "6": "-6", "u": "--udp", "t": "--tcp-connect", "v": "-v", "c1": "-c1", "c3": "-c3", "c5": "-c5",
"force4": "-4", "force6": "-6", "udp": "--udp", "tcp": "--tcp-connect", "verbose": "-v", "count1": "-c1", "count3": "-c3", "count5": "-c5",
}
var defaultopts []string
defaultopts = append(defaultopts, "-c3")
res := prerunner(req, cmd, cmdopts, defaultopts)
if strings.TrimSpace(res) == "" {
http.Error(w, "500: Internal Server Error", http.StatusInternalServerError)
} else {
_, _ = fmt.Fprint(w, strings.TrimSpace(res), "\n")
fmt.Fprint(w, strings.TrimSpace(res), "\n")
}
}
@ -232,8 +195,7 @@ func main() {
http.HandleFunc("/mtr/", mtr)
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)
http.ListenAndServe(fmt.Sprint(":", listenport), nil)
}