analyzer

package

v3.90.8 Latest Latest Go to latest Published: Sep 18, 2025 License: AGPL-3.0 Imports: 46 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

README ¶

Implementing Analyzers

Defining the Permissions

Permissions can be defined in:

lower snake case as permission_name:access_level
kebab case as permission-name:read
dot notation as permission.name:read

The Permissions are initially defined as a yaml file.

At the top of the analyzer implementation you specify the go generate command.

You can install the generator with go install github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/generate_permissions.

Then you can run go generate ./... to generate the Permission types for the analyzer.

The generated Permission types are to be used in the AnalyzerResult struct when defining the Permissions and in your code.

Documentation ¶

Index ¶

func Command(app *kingpin.Application) *kingpin.CmdClause
func Run(keyType string, secretInfo SecretInfo)
type SecretInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Command ¶

func Command(app *kingpin.Application) *kingpin.CmdClause

func Run ¶

func Run(keyType string, secretInfo SecretInfo)

Types ¶

type SecretInfo ¶ added in v3.88.6

type SecretInfo struct {
	Parts map[string]string
	Cfg   *config.Config
}

Source Files ¶

View all Source files

cli.go

Directories ¶

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

Path	Synopsis
analyzers
airbrake
airtable/airtableoauth
airtable/airtablepat
airtable/common Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
anthropic Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
asana Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
bitbucket Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
databricks Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
datadog
digitalocean Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
dockerhub Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
dropbox Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
elevenlabs Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
fastly Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
figma Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
github
github/classic Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
github/common
github/finegrained Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
gitlab Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
groq Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
huggingface Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
jira Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
launchdarkly Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
mailchimp Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
mailgun Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
monday Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
mux Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
mysql Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
netlify Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
ngrok Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
notion Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
openai Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
opsgenie Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
plaid Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
planetscale Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
postgres Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
posthog Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
postman Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
privatekey Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
sendgrid Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
shopify Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
slack Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
sourcegraph Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
square Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
stripe Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
twilio Code generated by go generate; DO NOT EDIT.	Code generated by go generate; DO NOT EDIT.
config
generate_permissions