Miccah
69021f59c5
* Refactor git source to allow ScanOptions and use source in engine Refactor the Chunks method of the git Source to call out to two helper methods: scanRepos and scanDirs which scans s.conn.Repositories and s.conn.Directories respectively. The only notable change in behavior is that a credential is no longer necessary if there are no s.conn.Repositories to scan. * Preserve ScanGit functionality of not cleaning up temporary files
78 lines
2.3 KiB
Go
78 lines
2.3 KiB
Go
package engine
|
|
|
|
import (
|
|
"fmt"
|
|
"runtime"
|
|
|
|
"github.com/go-errors/errors"
|
|
gogit "github.com/go-git/go-git/v5"
|
|
"google.golang.org/protobuf/proto"
|
|
"google.golang.org/protobuf/types/known/anypb"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/context"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/sourcespb"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/sources"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/sources/git"
|
|
)
|
|
|
|
// ScanGit scans any git source.
|
|
func (e *Engine) ScanGit(ctx context.Context, c sources.GitConfig) error {
|
|
logOptions := &gogit.LogOptions{}
|
|
opts := []git.ScanOption{
|
|
git.ScanOptionFilter(c.Filter),
|
|
git.ScanOptionLogOptions(logOptions),
|
|
}
|
|
|
|
if c.MaxDepth != 0 {
|
|
opts = append(opts, git.ScanOptionMaxDepth(int64(c.MaxDepth)))
|
|
}
|
|
if c.BaseRef != "" {
|
|
opts = append(opts, git.ScanOptionBaseHash(c.BaseRef))
|
|
}
|
|
if c.HeadRef != "" {
|
|
opts = append(opts, git.ScanOptionHeadCommit(c.HeadRef))
|
|
}
|
|
if c.ExcludeGlobs != nil {
|
|
opts = append(opts, git.ScanOptionExcludeGlobs(c.ExcludeGlobs))
|
|
}
|
|
scanOptions := git.NewScanOptions(opts...)
|
|
|
|
connection := &sourcespb.Git{
|
|
// Using Directories here allows us to not pass any
|
|
// authentication. Also by this point, the c.RepoPath should
|
|
// still have been prepared and downloaded to a temporary
|
|
// directory if it was a URL.
|
|
Directories: []string{c.RepoPath},
|
|
}
|
|
var conn anypb.Any
|
|
err := anypb.MarshalFrom(&conn, connection, proto.MarshalOptions{})
|
|
if err != nil {
|
|
ctx.Logger().Error(err, "failed to marshal git connection")
|
|
return err
|
|
}
|
|
|
|
gitSource := git.Source{}
|
|
if err := gitSource.Init(ctx, "trufflehog - git", 0, 0, true, &conn, runtime.NumCPU()); err != nil {
|
|
return errors.WrapPrefix(err, "could not init git source", 0)
|
|
}
|
|
gitSource.WithScanOptions(scanOptions)
|
|
// Don't try to clean up the provided directory. That's handled by the
|
|
// caller of ScanGit.
|
|
gitSource.WithPreserveTempDirs(true)
|
|
|
|
ctx = context.WithValues(ctx,
|
|
"source_type", sourcespb.SourceType_SOURCE_TYPE_GIT.String(),
|
|
"source_name", "git",
|
|
)
|
|
e.sourcesWg.Go(func() error {
|
|
defer common.RecoverWithExit(ctx)
|
|
err := gitSource.Chunks(ctx, e.ChunksChan())
|
|
if err != nil {
|
|
return fmt.Errorf("could not scan repo: %w", err)
|
|
}
|
|
return nil
|
|
})
|
|
return nil
|
|
}
|