Skip to content

Commit

Permalink
fix(gitparse): quoted binary files
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Gomez committed Feb 6, 2024
1 parent 901c851 commit 3fe2eff
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 14 deletions.
38 changes: 27 additions & 11 deletions pkg/gitparse/gitparse.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import (
"strings"
"time"

regexp "github.com/wasilibs/go-re2"

"github.com/go-logr/logr"

"github.com/trufflesecurity/trufflehog/v3/pkg/common"
Expand Down Expand Up @@ -528,10 +530,16 @@ func (c *Parser) FromReader(ctx context.Context, stdOut io.Reader, commitChan ch
case isBinaryLine(isStaged, latestState, line):
latestState = BinaryFileLine

currentDiff.PathB = pathFromBinaryLine(line)
path, err := pathFromBinaryLine(line)
if err != nil {
ctx.Logger().Error(err, "Failed to parse binary file line")
latestState = ParseFailure
continue
}

// Don't do anything if the file is deleted. (pathA has file path, pathB is /dev/null)
if currentDiff.PathB != "" {
if path != "" {
currentDiff.PathB = path
currentDiff.IsBinary = true
}
case isFromFileLine(isStaged, latestState, line):
Expand Down Expand Up @@ -777,16 +785,24 @@ func isBinaryLine(isStaged bool, latestState ParseState, line []byte) bool {
return false
}

var binaryPathPat = regexp.MustCompile(`Binary files .+ and (?:/dev/null|b/(.+)|"b/(.+)") differ`)

// Get the b/ file path. Ignoring the edge case of files having `and /b` in the name for simplicity.
func pathFromBinaryLine(line []byte) string {
logger := context.Background().Logger()
sbytes := bytes.Split(line, []byte(" and b/"))
if len(sbytes) != 2 {
logger.V(2).Info("Expected binary line to be in 'Binary files a/fileA and b/fileB differ' format.", "got", line)
return ""
}
bRaw := sbytes[1]
return string(bRaw[:len(bRaw)-8]) // drop the "b/" and " differ\n"
func pathFromBinaryLine(line []byte) (string, error) {
matches := binaryPathPat.FindSubmatch(line)
if len(matches) == 0 {
err := fmt.Errorf(`expected line to match 'Binary files a/fileA and b/fileB differ', got "%s"`, line)
return "", err
}

var path string
for _, match := range matches[1:] { // the first match is the entire input
if len(match) > 0 {
path = string(match)
break
}
}
return path, nil
}

// --- a/internal/addrs/move_endpoint_module.go
Expand Down
11 changes: 8 additions & 3 deletions pkg/gitparse/gitparse_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -667,12 +667,17 @@ Co-authored-by: Sergey Beryozkin <sberyozkin@gmail.com>

func TestBinaryPathParse(t *testing.T) {
cases := map[string]string{
"Binary files /dev/null and b/plugin.sig differ\n": "plugin.sig",
"Binary files /dev/null and b/ Lunch and Learn - HCDiag.pdf differ\n": " Lunch and Learn - HCDiag.pdf",
"Binary files a/trufflehog_3.42.0_linux_arm64.tar.gz and /dev/null differ\n": "",
"Binary files /dev/null and b/plugin.sig differ\n": "plugin.sig",
"Binary files /dev/null and b/ Lunch and Learn - HCDiag.pdf differ\n": " Lunch and Learn - HCDiag.pdf",
"Binary files /dev/null and \"b/assets/retailers/ON-ikony-Platforma-ecom \\342\\200\\224 kopia.png\" differ": "assets/retailers/ON-ikony-Platforma-ecom \\342\\200\\224 kopia.png",
}

for name, expected := range cases {
filename := pathFromBinaryLine([]byte(name))
filename, err := pathFromBinaryLine([]byte(name))
if err != nil {
t.Errorf("Got unexpected error: %s", err)
}
if filename != expected {
t.Errorf("Expected: %s, Got: %s", expected, filename)
}
Expand Down

0 comments on commit 3fe2eff

Please sign in to comment.