Merge pull request #7 from shadowy-pycoder/colors

Added nice colorization for sniffing output

Author: shadowy-pycoder

README.md

@@ -7,6 +7,8 @@
 ![GitHub Release](https://img.shields.io/github/v/release/shadowy-pycoder/go-http-proxy-to-socks)
 ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/shadowy-pycoder/go-http-proxy-to-socks/total)
 
+![GoHPTS - Colors example](resources/sniffing_color.png)
+
 ## Table of contents
 
 - [Introduction](#introduction)
@@ -19,6 +21,8 @@
   - [redirect (via NAT and SO_ORIGINAL_DST)](#redirect-via-nat-and-so_original_dst)
   - [tproxy (via MANGLE and IP_TRANSPARENT)](#tproxy-via-mangle-and-ip_transparent)
 - [Traffic sniffing](#traffic-sniffing)
+  - [JSON format](#json-format)
+  - [Colored format](#colored-format)
 - [Links](#links)
 - [Contributing](#contributing)
 - [License](#license)
@@ -93,7 +97,7 @@ You can download the binary for your platform from [Releases](https://github.com
 Example:
 
 ```shell
-HPTS_RELEASE=v1.7.2; wget -v https://github.com/shadowy-pycoder/go-http-proxy-to-socks/releases/download/$HPTS_RELEASE/gohpts-$HPTS_RELEASE-linux-amd64.tar.gz -O gohpts && tar xvzf gohpts && mv -f gohpts-$HPTS_RELEASE-linux-amd64 gohpts && ./gohpts -h
+HPTS_RELEASE=v1.8.0; wget -v https://github.com/shadowy-pycoder/go-http-proxy-to-socks/releases/download/$HPTS_RELEASE/gohpts-$HPTS_RELEASE-linux-amd64.tar.gz -O gohpts && tar xvzf gohpts && mv -f gohpts-$HPTS_RELEASE-linux-amd64 gohpts && ./gohpts -h
 ```
 
 Alternatively, you can install it using `go install` command (requires Go [1.24](https://go.dev/doc/install) or later):
@@ -139,10 +143,10 @@ Options:
         Address of transparent proxy server (no HTTP)
   -U string
         User for HTTP proxy (basic auth). This flag invokes prompt for password (not echoed to terminal)
+  -body
+        Collect request and response body for HTTP sniffing
   -c string
         Path to certificate PEM encoded file
-  -color
-        Enable colored output for logs in stdout (no effect if log file provided or -j flag specified)
   -d    Show logs in DEBUG mode
   -f string
         Path to server configuration file in YAML format
@@ -153,6 +157,8 @@ Options:
         Address of HTTP proxy server (default "127.0.0.1:8080")
   -logfile string
         Log file path (Default: stdout)
+  -nocolor
+        Disable colored output for logs (no effect if -j flag specified)
   -s string
         Address of SOCKS5 proxy server (default "127.0.0.1:1080")
   -sniff
@@ -430,6 +436,8 @@ ip link del veth1
 
 `GoHPTS` proxy allows one to capture and monitor traffic that goes through the service. This procces is known as `traffic sniffing`, `packet sniffing` or just `sniffing`. In particular, proxy tries to identify whether it is a plain text (HTTP) or TLS traffic, and after identification is done, it parses request/response metadata and writes it to the file or console. In the case of `GoHTPS` proxy a parsed metadata looks like the following (TLS Handshake):
 
+### JSON format
+
 ```json
 [
   {
@@ -551,16 +559,36 @@ And HTTP request with curl:
 Usage as simple as specifying `-sniff` flag along with regular flags
 
 ```shell
-gohpts -d -t 8888 -M redirect -sniff
+gohpts -d -t 8888 -M redirect -sniff -j
 ```
 
 You can also specify a file to which write sniffed traffic:
 
 ```shell
-gohpts -d -sniff -snifflog ~/sniff.log
+gohpts -sniff -snifflog ~/sniff.log -j
+```
+
+### Colored format
+
+You can see the example of colored output in the picture at the very top. In this mode, `GoHPTS` tries to highlight import information such as TLS Handshake, HTTP metadata, something that looks line login/passwords or different types of auth and secret tokens. The output is limited comparing to JSON but way easier to read for humans.
+
+To run `GoHPTS` in this mode you use the following flags:
+
+```shell
+gohpts -sniff -body
 ```
 
-Please note that for now sniffing only visible with `-d` flag, it may change in the future.
+You can combine sniffing with transparent mode:
+
+```shell
+./gohpts -T 8888 -M redirect -sniff -body
+```
+
+To disable colors add `-nocolor`:
+
+```shell
+gohpts -sniff -body -nocolor
+```
 
 ## Links
 

cmd/gohpts/cli.go

@@ -17,8 +17,7 @@ const (
 	addrHTTP  string = "127.0.0.1:8080"
 	tproxyOS  string = "linux"
 )
-const usagePrefix string = `                                                                  
-    _____       _    _ _____ _______ _____ 
+const usagePrefix string = `    _____       _    _ _____ _______ _____ 
   / ____|     | |  | |  __ \__   __/ ____|
  | |  __  ___ | |__| | |__) | | | | (___  
  | | |_ |/ _ \|  __  |  ___/  | |  \___ \ 
@@ -61,7 +60,8 @@ func root(args []string) error {
 	flags.BoolVar(&conf.Json, "j", false, "Show logs in JSON format")
 	flags.BoolVar(&conf.Sniff, "sniff", false, "Enable traffic sniffing for HTTP and TLS")
 	flags.StringVar(&conf.SniffLogFile, "snifflog", "", "Sniffed traffic log file path (Default: the same as -logfile)")
-	flags.BoolVar(&conf.Color, "color", false, "Enable colored output for logs in stdout (no effect if log file provided or -j flag specified)")
+	flags.BoolVar(&conf.NoColor, "nocolor", false, "Disable colored output for logs (no effect if -j flag specified)")
+	flags.BoolVar(&conf.Body, "body", false, "Collect request and response body for HTTP sniffing")
 	flags.BoolFunc("v", "print version", func(flagValue string) error {
 		fmt.Printf("%s (built for %s %s with %s)\n", gohpts.Version, runtime.GOOS, runtime.GOARCH, runtime.Version())
 		os.Exit(0)
@@ -83,7 +83,7 @@ func root(args []string) error {
 	}
 	if seen["t"] {
 		if !seen["M"] {
-			return fmt.Errorf("Transparent proxy mode is not provided: -M flag")
+			return fmt.Errorf("transparent proxy mode is not provided: -M flag")
 		}
 	}
 	if seen["T"] {
@@ -93,12 +93,12 @@ func root(args []string) error {
 			}
 		}
 		if !seen["M"] {
-			return fmt.Errorf("Transparent proxy mode is not provided: -M flag")
+			return fmt.Errorf("transparent proxy mode is not provided: -M flag")
 		}
 	}
 	if seen["M"] {
 		if !seen["t"] && !seen["T"] {
-			return fmt.Errorf("Transparent proxy mode requires -t or -T flag")
+			return fmt.Errorf("transparent proxy mode requires -t or -T flag")
 		}
 	}
 	if seen["f"] {
@@ -134,16 +134,16 @@ func root(args []string) error {
 		conf.ServerPass = string(bytepw)
 		fmt.Print("\033[2K\r")
 	}
-	if seen["sniff"] {
-		if !seen["d"] {
-			return fmt.Errorf("Traffic sniffing requires debug mode")
-		}
-	}
 	if seen["snifflog"] {
 		if !seen["sniff"] {
 			return fmt.Errorf("-snifflog only works with -sniff flag")
 		}
 	}
+	if seen["body"] {
+		if !seen["sniff"] {
+			return fmt.Errorf("-body only works with -sniff flag")
+		}
+	}
 
 	if *daemon {
 		if os.Getenv("GOHPTS_DAEMON") != "1" {

go.mod

@@ -4,7 +4,9 @@ go 1.24.1
 
 require (
 	github.com/goccy/go-yaml v1.18.0
+	github.com/google/uuid v1.6.0
 	github.com/rs/zerolog v1.34.0
+	github.com/shadowy-pycoder/colors v0.0.1
 	github.com/shadowy-pycoder/mshark v0.0.4
 	golang.org/x/net v0.40.0
 	golang.org/x/sys v0.33.0

go.sum

@@ -4,6 +4,8 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw=
 github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
@@ -15,6 +17,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/rs/xid v1.6.0/go.mod h1:7XoLgs4eV+QndskICGsho+ADou8ySMSjJKDIan90Nz0=
 github.com/rs/zerolog v1.34.0 h1:k43nTLIwcTVQAncfCw4KZ2VY6ukYoZaBPNOE8txlOeY=
 github.com/rs/zerolog v1.34.0/go.mod h1:bJsvje4Z08ROH4Nhs5iH600c3IkWhwp44iRc54W6wYQ=
+github.com/shadowy-pycoder/colors v0.0.1 h1:weCj/YIOupqy4BSP8KuVzr20fC+cuAv/tArz7bhhkP4=
+github.com/shadowy-pycoder/colors v0.0.1/go.mod h1:lkrJS1PY2oVigNLTT6pkbF7B/v0YcU2LD5PZnss1Q4U=
 github.com/shadowy-pycoder/mshark v0.0.4 h1:2yw6am1jt6n1GPHdLfFU1oDajv+zQ/23V0l0imFAeJY=
 github.com/shadowy-pycoder/mshark v0.0.4/go.mod h1:fRWGQuU4BFjz9pTfrvwIT2AtmWWd99PEvdlgv+24vTE=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=