Skip to content

Find, verify, and analyze leaked credentials

2.4 KB
Raw Blame
package engine

import (
	"fmt"
	"runtime"

	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/context"
	"github.com/trufflesecurity/trufflehog/v3/pkg/pb/sourcespb"
	"github.com/trufflesecurity/trufflehog/v3/pkg/sources"
	"github.com/trufflesecurity/trufflehog/v3/pkg/sources/git"
	"github.com/trufflesecurity/trufflehog/v3/pkg/sources/github_experimental"
)

// ScanGitHubExperimental scans GitHub using an experimental feature. Consider all functionality to be in an alpha release here.
func (e *Engine) ScanGitHubExperimental(ctx context.Context, c sources.GitHubExperimentalConfig) (sources.JobProgressRef, error) {
	connection := sourcespb.GitHubExperimental{
		Repository:         c.Repository,
		ObjectDiscovery:    c.ObjectDiscovery,
		CollisionThreshold: int64(c.CollisionThreshold),
		DeleteCachedData:   c.DeleteCachedData,
	}

	// Check at least one experimental sub-module is being used.
	// Add to this list as more experimental sub-modules are added.
	if !c.ObjectDiscovery {
		return sources.JobProgressRef{}, fmt.Errorf("at least one experimental submodule must be enabled")
	}

	if len(c.Token) > 0 {
		connection.Credential = &sourcespb.GitHubExperimental_Token{
			Token: c.Token,
		}
	} else {
		return sources.JobProgressRef{}, fmt.Errorf("token is required for github experimental")
	}

	var conn anypb.Any
	err := anypb.MarshalFrom(&conn, &connection, proto.MarshalOptions{})
	if err != nil {
		ctx.Logger().Error(err, "failed to marshal github experimental connection")
		return sources.JobProgressRef{}, err
	}

	logOptions := &gogit.LogOptions{}
	opts := []git.ScanOption{
		git.ScanOptionLogOptions(logOptions),
	}
	scanOptions := git.NewScanOptions(opts...)

	sourceName := "trufflehog - github experimental (alpha release)"
	sourceID, jobID, _ := e.sourceManager.GetIDs(ctx, sourceName, github_experimental.SourceType)
	ctx = withSourceFields(ctx, sourceName, github_experimental.SourceType, sourceID, jobID)

	githubExperimentalSource := &github_experimental.Source{}
	if err := githubExperimentalSource.Init(ctx, sourceName, jobID, sourceID, true, &conn, runtime.NumCPU()); err != nil {
		return sources.JobProgressRef{}, err
	}
	githubExperimentalSource.WithScanOptions(scanOptions)
	return e.sourceManager.EnumerateAndScan(ctx, sourceName, githubExperimentalSource)
}