Documentation
¶
Index ¶
Constants ¶
View Source
const ( // Version information AppName = "flowlyt" AppVersion = "0.0.7" AppUsage = "Multi-Platform CI/CD Security Analyzer" // Default configuration values DefaultMinSeverity = "LOW" DefaultOutputFormat = "cli" DefaultPlatform = "github" DefaultEntropyThreshold = 4.5 DefaultConfigFile = ".flowlyt.yml" DefaultMaxWorkers = 0 // 0 means use CPU count DefaultWorkflowTimeout = 30 // seconds DefaultTotalTimeout = 300 // seconds (5 minutes) // Supported platforms PlatformGitHub = "github" PlatformGitLab = "gitlab" // Supported output formats OutputFormatCLI = "cli" OutputFormatJSON = "json" OutputFormatMarkdown = "markdown" OutputFormatSARIF = "sarif" // Configuration file names ConfigFileFlowlytYML = ".flowlyt.yml" ConfigFileFlowlytYAML = ".flowlyt.yaml" ConfigFileBaseYML = "flowlyt.yml" ConfigFileBaseYAML = "flowlyt.yaml" // Severity levels SeverityInfo = "INFO" SeverityLow = "LOW" SeverityMedium = "MEDIUM" SeverityHigh = "HIGH" SeverityCritical = "CRITICAL" // Rule categories CategoryMaliciousPattern = "MaliciousPattern" CategoryShellObfuscation = "ShellObfuscation" CategoryMisconfiguration = "Misconfiguration" CategorySecretExposure = "SecretExposure" CategorySupplyChain = "SupplyChain" CategoryDataExfiltration = "DataExfiltration" CategoryReachability = "Reachability" CategoryDataFlow = "DataFlow" CategoryCallGraph = "CallGraph" // Common paths and patterns GitHubWorkflowsPath = ".github/workflows" GitLabCIFileName = ".gitlab-ci.yml" // GitHub Actions environment variables EnvGitHubActions = "GITHUB_ACTIONS" EnvCI = "CI" EnvGitHubActor = "GITHUB_ACTOR" EnvGitHubRunID = "GITHUB_RUN_ID" // Error messages ErrInvalidPlatform = "unsupported platform" ErrNoInputSpecified = "either --repo, --url, or --workflow must be specified" ErrConfigLoadFailed = "failed to load configuration" ErrWorkflowLoadFailed = "failed to load workflow file" ErrRepositoryCloneFailed = "failed to clone repository" )
Application constants
Variables ¶
View Source
var DefaultIgnorePatterns = []string{
"example",
"placeholder",
"test",
"dummy",
"sample",
"YOUR_SECRET_HERE",
"your-secret-here",
"changeme",
"change-me",
"XXXXXX",
"xxxxxx",
"000000",
"111111",
"password",
"secret",
"token",
"key",
"admin",
"user",
"default",
"localhost",
"127.0.0.1",
"0.0.0.0",
"::1",
}
Common false positive patterns that should be ignored
View Source
var SeverityLevels = map[string]int{ SeverityInfo: 0, SeverityLow: 1, SeverityMedium: 2, SeverityHigh: 3, SeverityCritical: 4, }
Severity level mapping for filtering
View Source
var SupportedOutputFormats = []string{ OutputFormatCLI, OutputFormatJSON, OutputFormatMarkdown, OutputFormatSARIF, }
Supported output formats list
View Source
var SupportedPlatforms = []string{ PlatformGitHub, PlatformGitLab, }
Supported platforms list
Functions ¶
func IsRunningInCI ¶
func IsRunningInCI() bool
IsRunningInCI detects if the application is running in a CI environment
func IsRunningInGitHubActions ¶
func IsRunningInGitHubActions() bool
IsRunningInGitHubActions specifically detects GitHub Actions environment
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.