github

package

v3.94.2 Latest Latest Go to latest Published: Apr 1, 2026 License: AGPL-3.0 Imports: 42 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/trufflesecurity/trufflehog

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Connector
type GistUnit
- func (g GistUnit) Display() string
- func (g GistUnit) SourceUnitID() (string, sources.SourceUnitKind)
type RepoUnit
- func (r RepoUnit) Display() string
- func (r RepoUnit) SourceUnitID() (string, sources.SourceUnitKind)
type Source

Constants ¶

View Source

const (
	SourceType = sourcespb.SourceType_SOURCE_TYPE_GITHUB
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Connector ¶ added in v3.88.14

type Connector interface {
	// APIClient returns a configured GitHub client that can be used for GitHub API operations.
	APIClient() *github.Client
	// GraphQLClient returns a client that can be used for GraphQL operations.
	GraphQLClient() *githubv4.Client
	// Clone clones a repository using the configured authentication information.
	Clone(ctx context.Context, repoURL string, args ...string) (string, *gogit.Repository, error)
}

Connector abstracts over the authenticated ways to interact with GitHub: cloning and API operations.

func NewAppConnector ¶ added in v3.88.14

func NewAppConnector(ctx context.Context, apiEndpoint string, app *credentialspb.GitHubApp) (Connector, error)

func NewBasicAuthConnector ¶ added in v3.88.14

func NewBasicAuthConnector(ctx context.Context, apiEndpoint, clonePath string, cred *credentialspb.BasicAuth) (Connector, error)

func NewTokenConnector ¶ added in v3.88.14

func NewTokenConnector(ctx context.Context, apiEndpoint, token, clonePath string, authInUrl bool, handleRateLimit func(context.Context, error) bool) (Connector, error)

func NewUnauthenticatedConnector ¶ added in v3.88.14

func NewUnauthenticatedConnector(ctx context.Context, apiEndpoint, clonePath string) (Connector, error)

type GistUnit ¶ added in v3.82.2

type GistUnit struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

func (GistUnit) Display ¶ added in v3.82.2

func (g GistUnit) Display() string

func (GistUnit) SourceUnitID ¶ added in v3.82.2

func (g GistUnit) SourceUnitID() (string, sources.SourceUnitKind)

type RepoUnit ¶ added in v3.82.2

type RepoUnit struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

func (RepoUnit) Display ¶ added in v3.82.2

func (r RepoUnit) Display() string

func (RepoUnit) SourceUnitID ¶ added in v3.82.2

func (r RepoUnit) SourceUnitID() (string, sources.SourceUnitKind)

type Source ¶

type Source struct {
	sources.Progress
	sources.CommonSourceUnitUnmarshaller
	// contains filtered or unexported fields
}

func (*Source) ChunkUnit ¶ added in v3.82.3

func (s *Source) ChunkUnit(ctx context.Context, unit sources.SourceUnit, reporter sources.ChunkReporter) error

func (*Source) Chunks ¶

func (s *Source) Chunks(ctx context.Context, chunksChan chan *sources.Chunk, targets ...sources.ChunkingTarget) error

Chunks emits chunks of bytes over a channel.

func (*Source) Enumerate ¶ added in v3.82.3

func (s *Source) Enumerate(ctx context.Context, reporter sources.UnitReporter) error

Enumerate enumerates the GitHub source based on authentication method and user configuration. It populates s.filteredRepoCache, s.repoInfoCache, s.memberCache, s.totalRepoSize, s.orgsCache, and s.repos. Additionally, repositories and gists are reported to the provided UnitReporter.

func (*Source) Init ¶

func (s *Source) Init(aCtx context.Context, name string, jobID sources.JobID, sourceID sources.SourceID, verify bool, connection *anypb.Any, concurrency int) error

Init returns an initialized GitHub source.

func (*Source) JobID ¶

func (s *Source) JobID() sources.JobID

func (*Source) SourceID ¶

func (s *Source) SourceID() sources.SourceID

func (*Source) Type ¶

func (s *Source) Type() sourcespb.SourceType

Type returns the type of source. It is used for matching source types in configuration and job input.

func (*Source) Validate ¶ added in v3.53.0

func (s *Source) Validate(ctx context.Context) []error

Validate is used by enterprise CLI to validate the GitHub config file.

func (*Source) WithCustomContentWriter ¶ added in v3.66.3

func (s *Source) WithCustomContentWriter()

WithCustomContentWriter sets the useCustomContentWriter flag on the source.

func (*Source) WithScanOptions ¶ added in v3.28.0

func (s *Source) WithScanOptions(scanOptions *git.ScanOptions)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL