Documentation
¶
Index ¶
- Constants
- func Bool(b bool) *bool
- func ComparePriority(priority1, priority2 string) int
- func CompareSeverity(severity1, severity2 string) int
- func Float32(f float32) *float32
- func Float64(f float64) *float64
- func Int(i int) *int
- func SeverityToPriority(severity string) string
- func String(s string) *string
- type Assignee
- type Code
- type CodeIgnore
- type Configuration
- type Dependencies
- type DependenciesIgnore
- type Integrations
- type Jira
- type Priorities
- type Secrets
- type SecretsCustomPattern
- type SecretsIgnore
Constants ¶
View Source
const ( PriorityUrgent string = "URGENT" PriorityImportant string = "IMPORTANT" PriorityInformational string = "INFORMATIONAL" PriorityUnknown string = "UNKNOWN" // To be deprecated PriorityNegligible string = "NEGIGIBLE" PriorityLow string = "LOW" PriorityMedium string = "MEDIUM" )
View Source
const ( SeverityCritical = "CRITICAL" SeverityHigh = "HIGH" SeverityMedium = "MEDIUM" SeverityLow = "LOW" SeverityUnknown = "UNKNOWN" )
Variables ¶
This section is empty.
Functions ¶
func ComparePriority ¶ added in v1.46.3
func CompareSeverity ¶ added in v1.37.1
func SeverityToPriority ¶ added in v1.46.5
Types ¶
type Code ¶ added in v1.12.0
type Code struct {
EnableFailBuilds *bool `yaml:"enable_fail_builds,omitempty"`
Ignore []CodeIgnore `yaml:"ignore,omitempty"`
}
type CodeIgnore ¶ added in v1.12.0
type CodeIgnore struct {
Reason string `yaml:"reason,omitempty"`
Expiry string `yaml:"expiry,omitempty"`
// matchers
CWEs []int `yaml:"cwes,omitempty"`
RuleIDs []string `yaml:"rule_ids,omitempty"`
Dirs []string `yaml:"dirs,omitempty"`
// global config only
Repositories []string `yaml:"repositories,omitempty"`
// TODO deprecate
Paths []string `yaml:"paths,omitempty"`
}
type Configuration ¶
type Configuration struct {
// git platform options
EnableFailBuilds *bool `yaml:"enable_fail_builds,omitempty"`
EnablePullRequestReviews *bool `yaml:"enable_pull_request_reviews,omitempty"`
EnableIssueDashboards *bool `yaml:"enable_issue_dashboards,omitempty"`
SeverityThreshold string `yaml:"severity_threshold,omitempty"`
PriorityThreshold string `yaml:"priority_threshold,omitempty"`
IgnoreDirs []string `yaml:"ignore_dirs,omitempty"`
IgnorePaths []string `yaml:"ignore_paths,omitempty"`
Integrations Integrations `yaml:"integrations,omitempty"`
// features
Code Code `yaml:"code"`
Dependencies Dependencies `yaml:"dependencies"`
Secrets Secrets `yaml:"secrets"`
// TODO deprecate
SecretsWhitelist []string `yaml:"secrets_whitelist,omitempty"`
}
func (*Configuration) GetEnableFailBuilds ¶ added in v1.35.0
func (c *Configuration) GetEnableFailBuilds() bool
func (*Configuration) GetEnableIssueDashboards ¶ added in v1.35.0
func (c *Configuration) GetEnableIssueDashboards() bool
func (*Configuration) GetEnablePullRequestReviews ¶ added in v1.35.0
func (c *Configuration) GetEnablePullRequestReviews() bool
type Dependencies ¶ added in v1.10.0
type Dependencies struct {
EnableFailBuilds *bool `yaml:"enable_fail_builds,omitempty"`
Ignore []DependenciesIgnore `yaml:"ignore,omitempty"`
}
type DependenciesIgnore ¶ added in v1.10.0
type DependenciesIgnore struct {
Reason string `yaml:"reason,omitempty"`
Expiry string `yaml:"expiry,omitempty"`
// matchers
CVEs []string `yaml:"cves,omitempty"`
Dirs []string `yaml:"dirs,omitempty"`
// global config only
Repositories []string `yaml:"repositories,omitempty"`
// TODO deprecate
Paths []string `yaml:"paths,omitempty"`
}
type Integrations ¶ added in v1.26.0
type Integrations struct {
Jira *Jira `yaml:"jira,omitempty"`
}
type Jira ¶ added in v1.26.0
type Jira struct {
Disabled bool `yaml:"disabled,omitempty"`
Enabled *bool `yaml:"enabled,omitempty"`
ProjectKey string `yaml:"project_key,omitempty"`
IssueType string `yaml:"issue_type,omitempty"`
SeverityThreshold string `yaml:"severity_threshold,omitempty"`
PriorityThreshold string `yaml:"priority_threshold,omitempty"`
OnFixTransition string `yaml:"on_fix_transition,omitempty"`
CommentOnClose *bool `yaml:"comment_on_close,omitempty"`
Labels []string `yaml:"labels,omitempty"`
TitleTemplate string `yaml:"title_template,omitempty"`
DescriptionTemplate string `yaml:"description_template,omitempty"`
Priorities *Priorities `yaml:"priorities,omitempty"`
Assignee *Assignee `yaml:"assignee,omitempty"`
}
type Priorities ¶ added in v1.27.0
type Priorities struct {
Critical string `yaml:"critical,omitempty"`
High string `yaml:"high,omitempty"`
Medium string `yaml:"medium,omitempty"`
Low string `yaml:"low,omitempty"`
Urgent string `yaml:"urgent,omitempty"`
Important string `yaml:"important,omitempty"`
Negligible string `yaml:"negligible,omitempty"`
}
Mapping of Nullify Finding severities to Jira Priorities. The user can specify the priority of the issue based on the severity.
type Secrets ¶ added in v1.11.0
type Secrets struct {
EnableFailBuilds *bool `yaml:"enable_fail_builds,omitempty"`
Ignore []SecretsIgnore `yaml:"ignore,omitempty"`
CustomPatterns map[string]SecretsCustomPattern `yaml:"custom_patterns,omitempty"`
CustomPatternsOverrideGlobal bool `yaml:"custom_patterns_override_global,omitempty"`
}
type SecretsCustomPattern ¶ added in v1.31.0
type SecretsCustomPattern struct {
Description *string `yaml:"description,omitempty"`
SecretRegex string `yaml:"secret_regex,omitempty"`
SecretRegexGroup *int `yaml:"secret_regex_group,omitempty"`
Entropy *float32 `yaml:"entropy,omitempty"`
PathRegex *string `yaml:"path_regex,omitempty"`
Keywords []string `yaml:"keywords,omitempty"`
}
type SecretsIgnore ¶ added in v1.11.0
type SecretsIgnore struct {
Reason string `yaml:"reason,omitempty"`
Expiry string `yaml:"expiry,omitempty"`
// matchers
Value string `yaml:"value,omitempty"`
Pattern string `yaml:"pattern,omitempty"`
SHA256 string `yaml:"sha256,omitempty"`
// global config only
Repositories []string `yaml:"repositories,omitempty"`
// TODO deprecate
Paths []string `yaml:"paths,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.