mirror of https://github.com/trufflesecurity/trufflehog.git synced 2026-05-16 13:20:35 +00:00

Files

T

History

John Elliott b0ee281ec3 Add nil check and error context to GitHub analyzer (#4858 )

Return an explicit error when AnalyzePermissions yields nil info
instead of passing nil to secretInfoToAnalyzerResult. Wrap classic
PAT repo/gist enumeration errors with context for easier debugging.

2026-04-02 15:56:49 -07:00

analyzers

Add nil check and error context to GitHub analyzer (#4858 )

2026-04-02 15:56:49 -07:00

config

[analyze] Implement Analyzer interface for github (#3110 )

2024-07-26 14:47:03 -07:00

generate_permissions

Support for kebab case and dot notation in permission generation tool (#3222 )

2024-08-15 10:07:42 -07:00

cli.go

[INS-241] Datadogapikey detector (#4627 )

2026-03-11 16:04:51 +05:00

README.md

Support for kebab case and dot notation in permission generation tool (#3222 )

2024-08-15 10:07:42 -07:00

README.md

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.