Fixed nocolor, headerlen spamming, updated README.md

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.3; 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):
@@ -154,7 +158,7 @@ Options:
   -logfile string
         Log file path (Default: stdout)
   -nocolor
-        Disable colored output for logs in stdout (no effect if log file provided or -j flag specified)
+        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
@@ -432,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
 [
   {
@@ -553,13 +559,35 @@ 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
+```
+
+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

@@ -61,7 +61,7 @@ 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.NoColor, "nocolor", false, "Disable 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())
@@ -84,7 +84,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"] {
@@ -94,12 +94,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"] {

gohpts.go

@@ -115,7 +115,6 @@ type proxyapp struct {
 	rrIndexReset   uint32
 	sniff          bool
 	nocolor        bool
-	sniffnocolor   bool
 	body           bool
 	json           bool
 
@@ -150,7 +149,7 @@ func randColor() func(string) *colors.Color {
 
 func (p *proxyapp) getId() string {
 	id := uuid.New()
-	if p.sniffnocolor {
+	if p.nocolor {
 		return fmt.Sprintf("%s", colors.WrapBrackets(id.String()))
 	}
 	return randColor()(fmt.Sprintf("%s", colors.WrapBrackets(id.String()))).String()
@@ -182,7 +181,7 @@ func (p *proxyapp) colorizeHTTP(req *http.Request, resp *http.Response, reqBodyS
 	if ts {
 		sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 	}
-	if p.sniffnocolor {
+	if p.nocolor {
 		sb.WriteString(id)
 		sb.WriteString(fmt.Sprintf(" %s %s %s ", req.Method, req.URL, req.Proto))
 		if req.UserAgent() != "" {
@@ -237,7 +236,7 @@ func (p *proxyapp) colorizeHTTP(req *http.Request, resp *http.Response, reqBodyS
 				sb.WriteString("\n")
 				sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 				sb.WriteString(id)
-				sb.WriteString(colors.GreenBg(" req_body: ").String())
+				sb.WriteString(colors.RedBgDark(" req_body: ").String())
 				sb.WriteString(b)
 			}
 		}
@@ -247,7 +246,7 @@ func (p *proxyapp) colorizeHTTP(req *http.Request, resp *http.Response, reqBodyS
 				sb.WriteString("\n")
 				sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 				sb.WriteString(id)
-				sb.WriteString(colors.GreenBg(" resp_body: ").String())
+				sb.WriteString(colors.RedBgDark(" resp_body: ").String())
 				sb.WriteString(b)
 			}
 		}
@@ -257,10 +256,10 @@ func (p *proxyapp) colorizeHTTP(req *http.Request, resp *http.Response, reqBodyS
 
 func (p *proxyapp) colorizeTLS(req *layers.TLSClientHello, resp *layers.TLSServerHello, id string) string {
 	var sb strings.Builder
-	if p.sniffnocolor {
+	if p.nocolor {
 		sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 		sb.WriteString(id)
-		sb.WriteString(fmt.Sprintf(" %s:", req.TypeDesc))
+		sb.WriteString(fmt.Sprintf(" %s ", req.TypeDesc))
 		if req.Length > 0 {
 			sb.WriteString(fmt.Sprintf(" Len: %d", req.Length))
 		}
@@ -277,7 +276,7 @@ func (p *proxyapp) colorizeTLS(req *layers.TLSClientHello, resp *layers.TLSServe
 			sb.WriteString(fmt.Sprintf(" ALPN: %v", req.ALPN))
 		}
 		sb.WriteString(" -> ")
-		sb.WriteString(fmt.Sprintf("%s:", resp.TypeDesc))
+		sb.WriteString(fmt.Sprintf("%s ", resp.TypeDesc))
 		if resp.Length > 0 {
 			sb.WriteString(fmt.Sprintf(" Len: %d", resp.Length))
 		}
@@ -293,7 +292,7 @@ func (p *proxyapp) colorizeTLS(req *layers.TLSClientHello, resp *layers.TLSServe
 	} else {
 		sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 		sb.WriteString(id)
-		sb.WriteString(colors.Magenta(fmt.Sprintf(" %s:", req.TypeDesc)).Bold())
+		sb.WriteString(colors.Magenta(fmt.Sprintf(" %s ", req.TypeDesc)).Bold())
 		if req.Length > 0 {
 			sb.WriteString(colors.BeigeBg(fmt.Sprintf(" Len: %d", req.Length)).String())
 		}
@@ -310,7 +309,7 @@ func (p *proxyapp) colorizeTLS(req *layers.TLSClientHello, resp *layers.TLSServe
 			sb.WriteString(colors.BlueBg(fmt.Sprintf(" ALPN: %v", req.ALPN)).String())
 		}
 		sb.WriteString(colors.MagentaBg(" -> ").String())
-		sb.WriteString(colors.LightBlue(fmt.Sprintf("%s:", resp.TypeDesc)).Bold())
+		sb.WriteString(colors.LightBlue(fmt.Sprintf("%s ", resp.TypeDesc)).Bold())
 		if resp.Length > 0 {
 			sb.WriteString(colors.BeigeBg(fmt.Sprintf(" Len: %d", resp.Length)).String())
 		}
@@ -343,7 +342,7 @@ func (p *proxyapp) highlightPatterns(line string) (string, bool) {
 func (p *proxyapp) replace(line string, re *regexp.Regexp, color func(string) *colors.Color, matched bool) (string, bool) {
 	if re.MatchString(line) {
 		matched = true
-		if !p.sniffnocolor {
+		if !p.nocolor {
 			line = re.ReplaceAllStringFunc(line, func(s string) string {
 				return color(s).String()
 			})
@@ -366,10 +365,10 @@ func (p *proxyapp) colorizeBody(b *[]byte) string {
 
 func (p *proxyapp) colorizeTimestamp() string {
 	ts := time.Now()
-	if p.sniffnocolor {
+	if p.nocolor {
 		return colors.WrapBrackets(ts.Format(time.TimeOnly))
 	}
-	return colors.GrayBg(colors.WrapBrackets(ts.Format(time.TimeOnly))).String()
+	return colors.Gray(colors.WrapBrackets(ts.Format(time.TimeOnly))).String()
 }
 
 func (p *proxyapp) colorizeTunnel(req, resp layers.Layer, sniffheader *[]string, id string) error {
@@ -936,13 +935,13 @@ func (p *proxyapp) handleTunnel(w http.ResponseWriter, r *http.Request) {
 			}
 		} else {
 			var sb strings.Builder
-			if p.sniffnocolor {
+			if p.nocolor {
 				sb.WriteString(id)
 				sb.WriteString(fmt.Sprintf(" Src: %s->%s -> Dst: %s->%s", srcConn.LocalAddr(), srcConn.RemoteAddr(), dstConn.LocalAddr(), dstConn.RemoteAddr()))
 				sb.WriteString("\n")
 				sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 				sb.WriteString(id)
-				sb.WriteString(fmt.Sprintf(" %s %s %s ", r.Method, r.URL, r.Proto))
+				sb.WriteString(fmt.Sprintf(" %s %s %s ", r.Method, r.Host, r.Proto))
 			} else {
 				sb.WriteString(id)
 				sb.WriteString(colors.Green(fmt.Sprintf(" Src: %s->%s", srcConn.LocalAddr(), srcConn.RemoteAddr())).String())
@@ -952,7 +951,7 @@ func (p *proxyapp) handleTunnel(w http.ResponseWriter, r *http.Request) {
 				sb.WriteString(fmt.Sprintf("%s ", p.colorizeTimestamp()))
 				sb.WriteString(id)
 				sb.WriteString(colors.Gray(fmt.Sprintf(" %s ", r.Method)).String())
-				sb.WriteString(colors.YellowBg(fmt.Sprintf("%s ", r.URL)).String())
+				sb.WriteString(colors.YellowBg(fmt.Sprintf("%s ", r.Host)).String())
 				sb.WriteString(colors.BlueBg(fmt.Sprintf("%s ", r.Proto)).String())
 			}
 			sniffheader = append(sniffheader, sb.String())
@@ -988,7 +987,7 @@ func (p *proxyapp) sniffreporter(wg *sync.WaitGroup, sniffheader *[]string, reqC
 			respQueue = respQueue[1:]
 
 			err := p.colorizeTunnel(req, resp, sniffheader, id)
-			if err == nil {
+			if err == nil && len(*sniffheader) > sniffheaderlen {
 				if p.json {
 					p.snifflogger.Log().Msg(fmt.Sprintf("[%s]", strings.Join(*sniffheader, ",")))
 				} else {
@@ -1304,8 +1303,7 @@ func New(conf *Config) *proxyapp {
 	} else {
 		snifflog = logfile
 	}
-	p.nocolor = conf.Json || (conf.NoColor && logfile == os.Stdout)
-	p.sniffnocolor = conf.Json || (conf.NoColor && logfile == os.Stdout)
+	p.nocolor = conf.Json || conf.NoColor
 	if conf.Json {
 		log.SetFlags(0)
 		jsonWriter := jsonLogWriter{file: logfile}
@@ -1361,13 +1359,13 @@ func New(conf *Config) *proxyapp {
 
 		}
 		logger = zerolog.New(output).With().Timestamp().Logger()
-		sniffoutput := zerolog.ConsoleWriter{Out: snifflog, TimeFormat: time.RFC3339, NoColor: p.sniffnocolor, PartsExclude: []string{"level"}}
+		sniffoutput := zerolog.ConsoleWriter{Out: snifflog, TimeFormat: time.RFC3339, NoColor: p.nocolor, PartsExclude: []string{"level"}}
 		sniffoutput.FormatTimestamp = func(i any) string {
 			ts, _ := time.Parse(time.RFC3339, i.(string))
 			if p.nocolor {
 				return colors.WrapBrackets(ts.Format(time.TimeOnly))
 			}
-			return colors.GrayBg(colors.WrapBrackets(ts.Format(time.TimeOnly))).String()
+			return colors.Gray(colors.WrapBrackets(ts.Format(time.TimeOnly))).String()
 		}
 		sniffoutput.FormatMessage = func(i any) string {
 			if i == nil || i == "" {

resources/.gitignore

@@ -1 +1,3 @@
+*
 !example_gohpts.yaml
+!sniffing_color.png

resources/sniffing_color.png

@@ -187,7 +187,7 @@ func (ts *tproxyServer) handleConnection(srcConn net.Conn) {
 				ts.pa.tproxyMode, srcConn.LocalAddr(), srcConn.RemoteAddr(), dstConn.LocalAddr(), dstConn.RemoteAddr(), dst))
 		} else {
 			var sb strings.Builder
-			if ts.pa.sniffnocolor {
+			if ts.pa.nocolor {
 				sb.WriteString(id)
 				sb.WriteString(fmt.Sprintf(" Src: %s->%s -> Dst: %s->%s Orig: %s", srcConn.LocalAddr(), srcConn.RemoteAddr(), dstConn.LocalAddr(), dstConn.RemoteAddr(), dst))
 			} else {

tproxy_linux.go

@@ -1,3 +1,3 @@
 package gohpts
 
-const Version string = "gohpts v1.7.3"
+const Version string = "gohpts v1.8.0"