trufflesecurity/trufflehog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move path parameter to the end of scanSymlink and scanDir parameter lists

Browse Source
This commit is contained in:
Charlie Gunyon
2026-03-10 16:08:09 +01:00
parent 1b5be0f02a
commit 43a81f91a1
2 changed files with 17 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/sources/filesystem/filesystem.go
+11 -13
View File
@@ -138,7 +138,7 @@ func (s *Source) Chunks(ctx trContext.Context, chunksChan chan *sources.Chunk, _
if fileInfo.Mode()&os.ModeSymlink != 0 { if fileInfo.Mode()&os.ModeSymlink != 0 {
ctx.Logger().V(5).Info("root path is a symlink") ctx.Logger().V(5).Info("root path is a symlink")
if err := s.scanSymlink(ctx, path, chunksChan, depth, rootPath); err != nil { if err := s.scanSymlink(ctx, chunksChan, depth, rootPath, path); err != nil {
ctx.Logger().Error(err, "error scanning root symlink") ctx.Logger().Error(err, "error scanning root symlink")
} }
continue continue
@@ -146,7 +146,7 @@ func (s *Source) Chunks(ctx trContext.Context, chunksChan chan *sources.Chunk, _
if fileInfo.IsDir() { if fileInfo.IsDir() {
ctx.Logger().V(5).Info("root path is a directory") ctx.Logger().V(5).Info("root path is a directory")
if err := s.scanDir(ctx, path, chunksChan, depth, rootPath); err != nil { if err := s.scanDir(ctx, chunksChan, depth, rootPath, path); err != nil {
ctx.Logger().Error(err, "error scanning root directory") ctx.Logger().Error(err, "error scanning root directory")
} }
continue continue
@@ -170,10 +170,9 @@ func (s *Source) Chunks(ctx trContext.Context, chunksChan chan *sources.Chunk, _
func (s *Source) scanSymlink( func (s *Source) scanSymlink(
ctx trContext.Context, ctx trContext.Context,
path string,
chunksChan chan *sources.Chunk, chunksChan chan *sources.Chunk,
depth int, depth int,
rootPath string, rootPath, path string,
) error { ) error {
fmt.Printf("scanning symlink %s\n", path) fmt.Printf("scanning symlink %s\n", path)
@@ -209,12 +208,12 @@ func (s *Source) scanSymlink(
if fileInfo.Mode()&os.ModeSymlink != 0 { if fileInfo.Mode()&os.ModeSymlink != 0 {
ctx.Logger().V(5).Info("symlink is a symlink") ctx.Logger().V(5).Info("symlink is a symlink")
return s.scanSymlink(ctx, resolvedPath, chunksChan, depth, rootPath) return s.scanSymlink(ctx, chunksChan, depth, rootPath, resolvedPath)
} }
if fileInfo.IsDir() { if fileInfo.IsDir() {
ctx.Logger().V(5).Info("symlink is a directory") ctx.Logger().V(5).Info("symlink is a directory")
return s.scanDir(ctx, resolvedPath, chunksChan, depth, rootPath) return s.scanDir(ctx, chunksChan, depth, rootPath, resolvedPath)
} }
if !fileInfo.Mode().Type().IsRegular() { if !fileInfo.Mode().Type().IsRegular() {
@@ -237,10 +236,9 @@ func (s *Source) scanSymlink(
func (s *Source) scanDir( func (s *Source) scanDir(
ctx trContext.Context, ctx trContext.Context,
path string,
chunksChan chan *sources.Chunk, chunksChan chan *sources.Chunk,
depth int, depth int,
rootPath string, rootPath, path string,
) error { ) error {
// check if the full path is not matching any pattern in include // check if the full path is not matching any pattern in include
// FilterRuleSet and matching any exclude FilterRuleSet. // FilterRuleSet and matching any exclude FilterRuleSet.
@@ -304,7 +302,7 @@ func (s *Source) scanDir(
// traverse into it to find where to resume. // traverse into it to find where to resume.
if entry.IsDir() && strings.HasPrefix(resumeAfter, entryPath+string(filepath.Separator)) { if entry.IsDir() && strings.HasPrefix(resumeAfter, entryPath+string(filepath.Separator)) {
// Recurse into this directory to find the resume point. // Recurse into this directory to find the resume point.
if err := s.scanDir(ctx, entryPath, chunksChan, depth, rootPath); err != nil { if err := s.scanDir(ctx, chunksChan, depth, rootPath, entryPath); err != nil {
ctx.Logger().Error(err, "error scanning directory", "path", entryPath) ctx.Logger().Error(err, "error scanning directory", "path", entryPath)
} }
// After recursing, clear local resumeAfter. The child scanDir will have // After recursing, clear local resumeAfter. The child scanDir will have
@@ -319,7 +317,7 @@ func (s *Source) scanDir(
if entry.Type()&os.ModeSymlink != 0 { if entry.Type()&os.ModeSymlink != 0 {
ctx.Logger().V(5).Info("entry is a symlink") ctx.Logger().V(5).Info("entry is a symlink")
if err := s.scanSymlink(ctx, entryPath, chunksChan, depth, rootPath); err != nil { if err := s.scanSymlink(ctx, chunksChan, depth, rootPath, entryPath); err != nil {
ctx.Logger().Error(err, "error scanning symlink") ctx.Logger().Error(err, "error scanning symlink")
} }
@@ -328,7 +326,7 @@ func (s *Source) scanDir(
if entry.IsDir() { if entry.IsDir() {
ctx.Logger().V(5).Info("entry is a directory") ctx.Logger().V(5).Info("entry is a directory")
if err := s.scanDir(ctx, entryPath, chunksChan, depth, rootPath); err != nil { if err := s.scanDir(ctx, chunksChan, depth, rootPath, entryPath); err != nil {
ctx.Logger().Error(err, "error scanning directory") ctx.Logger().Error(err, "error scanning directory")
} }
@@ -458,7 +456,7 @@ func (s *Source) ChunkUnit(ctx trContext.Context, unit sources.SourceUnit, repor
if fileInfo.Mode()&os.ModeSymlink != 0 { if fileInfo.Mode()&os.ModeSymlink != 0 {
fmt.Println("unit is a symlink") fmt.Println("unit is a symlink")
ctx.Logger().V(5).Info("unit is a symlink") ctx.Logger().V(5).Info("unit is a symlink")
if err := s.scanSymlink(ctx, path, ch, depth, rootPath); err != nil { if err := s.scanSymlink(ctx, ch, depth, rootPath, path); err != nil {
ctx.Logger().Error(err, "error scanning symlink unit") ctx.Logger().Error(err, "error scanning symlink unit")
scanErr = err scanErr = err
} }
@@ -470,7 +468,7 @@ func (s *Source) ChunkUnit(ctx trContext.Context, unit sources.SourceUnit, repor
fmt.Println("unit is a directory") fmt.Println("unit is a directory")
ctx.Logger().V(5).Info("unit is a directory") ctx.Logger().V(5).Info("unit is a directory")
// TODO: Finer grain error tracking of individual chunks. // TODO: Finer grain error tracking of individual chunks.
if err := s.scanDir(ctx, path, ch, depth, rootPath); err != nil { if err := s.scanDir(ctx, ch, depth, rootPath, path); err != nil {
ctx.Logger().Error(err, "error scanning directory unit") ctx.Logger().Error(err, "error scanning directory unit")
scanErr = err scanErr = err
} }
pkg/sources/filesystem/filesystem_symlink_test.go
+6 -6
View File
@@ -505,7 +505,7 @@ func TestScanSymlink_NoError(t *testing.T) {
} }
chunks := make(chan *sources.Chunk, 10) chunks := make(chan *sources.Chunk, 10)
go func() { go func() {
err := src.scanSymlink(ctx, filepath.Join(baseDir, "A"), chunks, 0, filepath.Join(baseDir, "A")) err := src.scanSymlink(ctx, chunks, 0, filepath.Join(baseDir, "A"), filepath.Join(baseDir, "A"))
require.NoError(t, err) require.NoError(t, err)
close(chunks) close(chunks)
}() }()
@@ -552,7 +552,7 @@ func TestScanSymlink_MaxDepthExceeded(t *testing.T) {
} }
chunks := make(chan *sources.Chunk, 10) chunks := make(chan *sources.Chunk, 10)
err = src.scanSymlink(ctx, filepath.Join(baseDir, "A"), chunks, 0, filepath.Join(baseDir, "A")) err = src.scanSymlink(ctx, chunks, 0, filepath.Join(baseDir, "A"), filepath.Join(baseDir, "A"))
close(chunks) close(chunks)
require.Error(t, err) require.Error(t, err)
require.EqualError(t, err, "max symlink depth reached") require.EqualError(t, err, "max symlink depth reached")
@@ -583,7 +583,7 @@ func TestScanSymlink_FileTarget(t *testing.T) {
} }
chunks := make(chan *sources.Chunk, 10) chunks := make(chan *sources.Chunk, 10)
err = src.scanSymlink(ctx, symlinkPath, chunks, 1, symlinkPath) err = src.scanSymlink(ctx, chunks, 1, symlinkPath, symlinkPath)
require.NoError(t, err) require.NoError(t, err)
close(chunks) close(chunks)
var chunkCount int var chunkCount int
@@ -614,7 +614,7 @@ func TestScanSymlink_SelfLoop(t *testing.T) {
} }
chunks := make(chan *sources.Chunk, 10) chunks := make(chan *sources.Chunk, 10)
err = src.scanSymlink(ctx, symlinkPath, chunks, 1, symlinkPath) err = src.scanSymlink(ctx, chunks, 1, symlinkPath, symlinkPath)
close(chunks) close(chunks)
require.Error(t, err) require.Error(t, err)
require.EqualError(t, err, "max symlink depth reached") require.EqualError(t, err, "max symlink depth reached")
@@ -640,7 +640,7 @@ func TestScanSymlink_BrokenSymlink(t *testing.T) {
chunks := make(chan *sources.Chunk, 10) chunks := make(chan *sources.Chunk, 10)
err = src.scanSymlink(ctx, symlinkPath, chunks, 0, symlinkPath) err = src.scanSymlink(ctx, chunks, 0, symlinkPath, symlinkPath)
close(chunks) close(chunks)
require.Error(t, err) require.Error(t, err)
require.Contains(t, err.Error(), "lstat error") require.Contains(t, err.Error(), "lstat error")
@@ -668,7 +668,7 @@ func TestScanSymlink_TwoFileLoop(t *testing.T) {
} }
chunks := make(chan *sources.Chunk, 10) chunks := make(chan *sources.Chunk, 10)
err = src.scanSymlink(ctx, fileA, chunks, 0, fileA) err = src.scanSymlink(ctx, chunks, 0, fileA, fileA)
close(chunks) close(chunks)
require.Error(t, err) require.Error(t, err)
require.EqualError(t, err, "max symlink depth reached") require.EqualError(t, err, "max symlink depth reached")