mirror of
https://github.com/trufflesecurity/trufflehog.git
synced 2024-11-15 01:17:34 +00:00
a8777fcad9
This is currently a one-way operation. Once you select "analyze" you cannot get back to the main menu. |
||
---|---|---|
.. | ||
analyzers | ||
config | ||
generate_permissions | ||
pb/analyzerpb | ||
proto | ||
tui | ||
cli.go | ||
README.md |
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.