Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
package analyzers
import "fmt"
// Operation constants for AnalysisError.
const (
OperationValidateCredentials = "validate_credentials"
OperationAnalyzePermissions = "analyze_permissions"
)
// Service constants for AnalysisError.
const (
ServiceAPI = "API"
ServiceConfig = "config"
ServiceDatabase = "Database"
ServiceOAuth = "OAuth"
ServiceCrypto = "crypto"
)
// AnalysisErrorInfo is implemented by errors that provide structured context
// about analysis failures. This allows downstream consumers (e.g., the scanner)
// to extract metadata for structured error storage without depending on
// concrete error types.
type AnalysisErrorInfo interface {
error
AnalyzerType() string
Operation() string // "validate_credentials", "authenticate", "analyze_permissions", "connect", "ping"
Service() string // "config", "API", "OAuth", "Database"
Resource() string // account ID, endpoint URL, or other identifier
}
// AnalysisError represents a structured error from an analyzer.
type AnalysisError struct {
analyzerType string
operation string
service string
resource string
err error
}
// NewAnalysisError creates a new AnalysisError.
func NewAnalysisError(analyzerType, operation, service, resource string, err error) *AnalysisError {
return &AnalysisError{
analyzerType: analyzerType,
operation: operation,
service: service,
resource: resource,
err: err,
}
}
func (e *AnalysisError) Error() string {
var resource string
if e.resource != "" {
resource = fmt.Sprintf(" (resource: %s)", e.resource)
}
if e.err != nil {
return fmt.Sprintf("%s analysis failed: %s on %s%s: %v",
e.analyzerType, e.operation, e.service, resource, e.err)
}
return fmt.Sprintf("%s analysis failed: %s on %s%s",
e.analyzerType, e.operation, e.service, resource)
}
func (e *AnalysisError) Unwrap() error { return e.err }
func (e *AnalysisError) AnalyzerType() string { return e.analyzerType }
func (e *AnalysisError) Operation() string { return e.operation }
func (e *AnalysisError) Service() string { return e.service }
func (e *AnalysisError) Resource() string { return e.resource }