trufflehog/pkg/analyzer
Miccah 3db9ed7c74
[chore] Fix lint errors (#3218)
* [chore] Fix lint errors under analyzer package

* Fix lint error in source manager test

* Use Sprint instead of Sprintf where appropriate
2024-08-14 13:49:24 -07:00
..
analyzers [chore] Fix lint errors (#3218) 2024-08-14 13:49:24 -07:00
config [analyze] Implement Analyzer interface for github (#3110) 2024-07-26 14:47:03 -07:00
generate_permissions [analyze] Fix off-by-one error in generated data structures (#3162) 2024-08-02 14:22:22 -07:00
pb/analyzerpb Analyze (#3099) 2024-07-25 12:06:05 -07:00
proto Analyze (#3099) 2024-07-25 12:06:05 -07:00
tui [analyze] Bandaid solution for occasional slow startups (#3191) 2024-08-06 22:24:58 -07:00
cli.go Analyzer capitalization (#3188) 2024-08-06 17:00:40 -07:00
README.md Add permissions lookup tables (#3125) 2024-07-31 13:01:29 -07:00

Implementing Analyzers

Defining the Permissions

Permissions are defined in lower snake case as permission_name:access_level.

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.