Merge pull request #56 from tstromberg/main

Shorten terminal rendering width

Author: tstromberg

bincapz_test.go

@@ -185,7 +185,7 @@ func TestDiff(t *testing.T) {
 
 			got := out.String()
 			if diff := cmp.Diff(got, want); diff != "" {
-				t.Errorf("unexpected diff: %s\ngot: %s", diff, got)
+				t.Errorf("unexpected diff: %s", diff)
 			}
 
 		})

pkg/render/terminal.go

@@ -133,14 +133,22 @@ func renderTable(fr *bincapz.FileReport, w io.Writer, rc tableConfig) {
 	tWidth := terminalWidth()
 	keyWidth := 36
 	riskWidth := 7
-	padding := 7
-	descWidth := tWidth - keyWidth - riskWidth - padding
+	padding := 4
+	maxKeyLen := 0
+
+	for _, k := range kbs {
+		key := forceWrap(k.Key, keyWidth)
+		if len(key) > maxKeyLen {
+			maxKeyLen = len(key)
+		}
+	}
+
+	descWidth := tWidth - maxKeyLen - riskWidth - padding
 	if descWidth > 120 {
 		descWidth = 120
 	}
 
 	klog.Infof("terminal width: %d - desc width: %d", tWidth, descWidth)
-	maxKeyLen := 0
 
 	for _, k := range kbs {
 		desc := k.Behavior.Description
@@ -155,6 +163,8 @@ func renderTable(fr *bincapz.FileReport, w io.Writer, rc tableConfig) {
 				desc = fmt.Sprintf("by %s", k.Behavior.RuleAuthor)
 			}
 		}
+
+		key := forceWrap(k.Key, keyWidth)
 		words, _ := tablewriter.WrapString(desc, descWidth)
 
 		//		klog.Infof("%s / %s - %s", k.Key, desc, k.Behavior.)
@@ -171,11 +181,6 @@ func renderTable(fr *bincapz.FileReport, w io.Writer, rc tableConfig) {
 			desc = fmt.Sprintf("%s:%s%s%s", desc, before, forceWrap(strings.Join(k.Behavior.Values, "\n"), descWidth), after)
 		}
 
-		key := forceWrap(k.Key, keyWidth)
-		if len(key) > maxKeyLen {
-			maxKeyLen = len(key)
-		}
-
 		// lowercase first character for consistency
 		desc = strings.ToLower(string(desc[0])) + desc[1:]
 		risk := fmt.Sprintf("%d/%s", k.Behavior.RiskScore, k.Behavior.RiskLevel)
@@ -191,14 +196,31 @@ func renderTable(fr *bincapz.FileReport, w io.Writer, rc tableConfig) {
 
 	if title != "" {
 		fmt.Fprintf(w, "%s\n", title)
-		fmt.Fprintf(w, "%s\n", strings.Repeat("-", 70))
 	}
 
 	table := tablewriter.NewWriter(os.Stdout)
 	table.SetAutoWrapText(false)
 	//	table.SetHeader([]string{"Risk", "Key", "Description"})
 	table.SetBorder(false)
-	//	ttable.SetBorders(tablewriter.Border{Left: false, Top: true, Right: false, Bottom: false})
+	table.SetCenterSeparator("")
+	// SetBorders miscalculates length with NoWhiteSpace
+	//table.SetBorders(tablewriter.Border{Left: false, Top: true, Right: false, Bottom: false})
+	maxDescWidth := 0
+	maxRiskWidth := 0
+	for _, d := range data {
+		if len(d[0]) > maxRiskWidth {
+			maxRiskWidth = len(d[0])
+		}
+		for _, l := range strings.Split(d[2], "\n") {
+			if len(l) > maxDescWidth {
+				maxDescWidth = len(l)
+			}
+		}
+
+	}
+	tableWidth := maxKeyLen + maxDescWidth + padding + maxRiskWidth
+	klog.Infof("table width: %d", tableWidth)
+	fmt.Fprintf(w, "%s\n", strings.Repeat("-", tableWidth))
 	table.SetNoWhiteSpace(true)
 	table.SetTablePadding("  ")
 	descColor := tablewriter.Normal

rules/fs/directory-traverse.yara

@@ -1,6 +1,6 @@
 rule fts {
 	meta:
-		description = "traverse filesystem hierarchies"
+		description = "traverse filesystem hierarchy"
 		syscall = "openat,getdents"
 		pledge = "rpath"
 	strings:
@@ -15,7 +15,7 @@ rule fts {
 
 rule py_walk : notable {
 	meta:
-		description = "traverse filesystem hierarchies"
+		description = "traverse filesystem hierarchy"
 	strings:
 		$walk = "os.walk"
 	condition:

rules/fs/permission-get.yara

@@ -1,6 +1,6 @@
 rule getmode {
 	meta:
-		description = "Uses libc functions to access filesystem information"
+		description = "looks up file permissions"
 		pledge = "rpath"
 	strings:
 		$_chmod = "_getmode"

rules/fs/permission-modify.yara

@@ -1,6 +1,6 @@
 rule chmod : notable {
 	meta:
-		description = "modifies file permissions using chmod"
+		description = "modifies file permissions"
 		pledge = "fattr"
 		syscall = "chmod"
 	strings:
@@ -14,7 +14,7 @@ rule chmod : notable {
 
 rule fchmod : notamble {
 	meta:
-		description = "modifies file permissions using fchmod"
+		description = "modifies file permissions"
 		pledge = "fattr"
 		syscall = "fchmodat"
 	strings:

testdata/macOS/libffmpeg.dirty.mdiff

@@ -11,7 +11,7 @@
 | +1/LOW  | **random/insecure**                          | generate random numbers insecurely                                                                                                               |
 | +1/LOW  | **sync/semaphore/user**                      | uses semaphores to synchronize data between processes or threads                                                                                 |
 | +2/MED  | **exec/pipe**                                | uses popen to launch a program and pipe output to/from it                                                                                        |
-| +2/MED  | **fs/permission/modify**                     | modifies file permissions using chmod                                                                                                            |
+| +2/MED  | **fs/permission/modify**                     | modifies file permissions                                                                                                                        |
 | +2/MED  | **net/http/cookies**                         | able to access HTTP resources using cookies                                                                                                      |
 | +2/MED  | **net/url/request**                          | requests resources via URL                                                                                                                       |
 | +2/MED  | **ref/path/hidden**                          | references a hidden file that can be generated dynamically: "%s/.main_storage"                                                                   |