Merge pull request #310 from lunasec-io/cli-ux

Cli ux

tools/log4shell/.goreleaser.yml

@@ -12,12 +12,14 @@ builds:
       - windows
       - darwin
 archives:
-  - replacements:
+  - format: binary
+    replacements:
       darwin: Darwin
       linux: Linux
       windows: Windows
       386: i386
       amd64: x86_64
+
 checksum:
   name_template: 'checksums.txt'
 snapshot:

tools/log4shell/constants/colorize.go

@@ -0,0 +1,32 @@
+// Copyright 2021 by LunaSec (owned by Refinery Labs, Inc)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+package constants
+
+type TerminalColor int
+
+const (
+	ColorBlack TerminalColor = iota + 30
+	ColorRed
+	ColorGreen
+	ColorYellow
+	ColorBlue
+	ColorMagenta
+	ColorCyan
+	ColorWhite
+
+	ColorBold     = 1
+	ColorDarkGray = 90
+)
+

tools/log4shell/constants/version.go

@@ -14,4 +14,4 @@
 //
 package constants
 
-const Version = "1.1.0"
+const Version = "1.1.1"

tools/log4shell/main.go

@@ -16,6 +16,7 @@ package main
 
 import (
 	"encoding/json"
+	"fmt"
 	"github.com/lunasec-io/lunasec/tools/log4shell/constants"
 	"github.com/lunasec-io/lunasec/tools/log4shell/patch"
 	"github.com/lunasec-io/lunasec/tools/log4shell/scan"
@@ -44,7 +45,12 @@ func enableGlobalFlags(c *cli.Context) {
 	jsonFlag := c.Bool("json")
 	if !jsonFlag {
 		// pretty print output to the console if we are not interested in parsable output
-		log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+		consoleOutput := zerolog.ConsoleWriter{Out: os.Stderr}
+		consoleOutput.FormatFieldName = func(i interface{}) string {
+			return fmt.Sprintf("\n\t%s: ", util.Colorize(constants.ColorBlue, i))
+		}
+		log.Logger = log.Output(consoleOutput)
+
 	}
 }
 
@@ -93,7 +99,7 @@ func hotpatchCommand(c *cli.Context) error {
 
 	log.Info().
 		Msg("Starting Log4Shell hotpatch LDAP and payload servers")
-
+	log.Info().Msgf("Once both servers have started, use payload string: '${jndi:ldap://%s:1389/a}' to hotpatch", ip)
 	hotpatchServer.Start()
 	hotpatchPayloadServer.Start()
 

tools/log4shell/patch/hotpatch.go

@@ -61,14 +61,15 @@ func (s *HotpatchLDAPServer) Start() {
 		addr := "0.0.0.0:1389"
 		log.Info().
 			Str("addr", addr).
-			Msg("starting hotpatch server")
+			Msg("Started hotpatch server")
 		err := s.server.ListenAndServe(addr)
 		if err != nil {
 			log.Error().
 				Err(err).
 				Msg("unable to start ldap server")
 			panic(err)
 		}
+		log.Info().Msg("HotPatch Server Started")
 	}()
 }
 

tools/log4shell/patch/payloadserver.go

@@ -67,7 +67,7 @@ func (s *HotpatchPayloadServer) Start() {
 		addr := fmt.Sprintf("0.0.0.0:%d", constants.HotpatchServerPort)
 		log.Info().
 			Str("addr", addr).
-			Msg("starting hotpatch payload server")
+			Msg("Started hotpatch payload server")
 		err := http.ListenAndServe(addr, nil)
 		if err != nil {
 			log.Error().

tools/log4shell/util/colorize.go

@@ -0,0 +1,26 @@
+// Copyright 2021 by LunaSec (owned by Refinery Labs, Inc)
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+package util
+
+import (
+	"fmt"
+	"github.com/lunasec-io/lunasec/tools/log4shell/constants"
+)
+
+// colorize returns the string s wrapped in ANSI code c, unless disabled is true.
+func Colorize(c constants.TerminalColor, s interface{}) string {
+	return fmt.Sprintf("\x1b[%dm%v\x1b[0m", c, s)
+}