Terminology

secrets secrets, or more generally credentials, are the data that is scanned for examples of secrets include access keys/tokens, api keys, passwords, etc secret states live the secret is verified and is active never live the secret was never verified as active rotated/deactivated the secret was verified as live at one point, and has since been verified as not live all any secret that was found triage states not triaged the secret has not been triaged invalid the secret is marked invalid by the user this could be for any reason for example, the secret is wrong resolved the secret was marked as resolved by the user useful for when the secret was removed before trufflehog could verify that it is no longer active will not fix the secret was marked as will not fix by the user common reasons are risk acceptance and canary tokens configuration sources integrations that provide data to be scanned they are configured via a local configuration file, or in the web ui examples of sources include slack, jira, github, s3, etc see the docid 91jgobvg nkxphml0ko7k part of the documentation for more information notifiers integrations for sending notifications for found secrets examples of notifiers include email, slack message, jira ticket, or a webhook see the docid 3x2gi1gjncqbcagjfqssw part of the documentation for more information scanners (agents) the component that scan for secrets and verify them metadata of the secret is sent to the configured notifiers and to your hosted web ui see the rest of the docid\ thkh glbmurkdwud7wbmh documentation for creating and configuring a scanner by default, scanners are part of the hosted scanner group the hosted scanner group is run for you in truffle security infrastructure in your own isolated environment additionally, scanners can be setup to run on your own hardware these scanners will be placed in an individually created scanner group scanner group (agent group) used to manage multiple scanners you configure scanner groups in the web ui a scanner group can run more than one scanner instance, and scan jobs will run across those instances detectors the individual rules and signature types that trufflehog uses to find secrets, credentials, and other sensitive data across source code, logs, configs, containers, cloud resources, and more each detector focuses on a particular kind of secret to customize detection see the https //docs trufflesecurity com/custom detectors documentation