Documentation
¶
Index ¶
- Constants
- type Configuration
- type Dependencies
- type DependenciesIgnore
- type Notification
- type NotificationEventAll
- type NotificationEventNewAPIFindings
- type NotificationEventNewCodeFindings
- type NotificationEventNewDependencyFindings
- type NotificationEventNewSecretFindings
- type NotificationEvents
- type NotificationTargetEmail
- type NotificationTargetSlack
- type NotificationTargetWebhook
- type NotificationTargets
- type ScheduledNotification
- type ScheduledNotificationTargetEmail
- type ScheduledNotificationTargetSlack
- type ScheduledNotificationTargets
- type ScheduledNotificationTopics
Constants ¶
View Source
const ( ScheduledNotificationTopicTypeAll = "all" ScheduledNotificationTopicTypeCode = "code" ScheduledNotificationTopicTypeIaC = "iac" ScheduledNotificationTopicTypeDependencies = "dependencies" ScheduledNotificationTopicTypeSecrets = "secrets" ScheduledNotificationTopicTypeDAST = "dast" )
View Source
const ( SeverityCritical = "CRITICAL" SeverityHigh = "HIGH" SeverityMedium = "MEDIUM" SeverityLow = "LOW" SeverityUnknown = "UNKNOWN" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct {
SeverityThreshold string `yaml:"severity_threshold,omitempty"`
IgnoreDirs []string `yaml:"ignore_dirs,omitempty"`
IgnorePaths []string `yaml:"ignore_paths,omitempty"`
SecretsWhitelist []string `yaml:"secrets_whitelist,omitempty"` // TODO deprecate
SecretsAllowlist []string `yaml:"secrets_allowlist,omitempty"`
Dependencies Dependencies `yaml:"dependencies,omitempty"`
Notifications map[string]Notification `yaml:"notifications,omitempty"`
ScheduledNotifications map[string]ScheduledNotification `yaml:"scheduled_notifications,omitempty"`
}
type Dependencies ¶ added in v1.10.0
type Dependencies struct {
Ignore []DependenciesIgnore `yaml:"ignore,omitempty"`
}
type DependenciesIgnore ¶ added in v1.10.0
type Notification ¶ added in v1.9.0
type Notification struct {
Events NotificationEvents `yaml:"events,omitempty"`
Targets NotificationTargets `yaml:"targets,omitempty"`
}
type NotificationEventAll ¶ added in v1.9.0
type NotificationEventNewAPIFindings ¶ added in v1.9.0
type NotificationEventNewCodeFindings ¶ added in v1.9.0
type NotificationEventNewDependencyFindings ¶ added in v1.9.0
type NotificationEventNewSecretFindings ¶ added in v1.9.0
type NotificationEventNewSecretFindings struct {
Types []string `yaml:"types,omitempty"`
}
type NotificationEvents ¶ added in v1.9.0
type NotificationEvents struct {
All *NotificationEventAll `yaml:"all,omitempty"`
NewAPIFindings *NotificationEventNewAPIFindings `yaml:"new_api_findings,omitempty"`
NewCodeFindings *NotificationEventNewCodeFindings `yaml:"new_code_findings,omitempty"`
NewDependencyFindings *NotificationEventNewDependencyFindings `yaml:"new_dependency_findings,omitempty"`
NewSecretFindings *NotificationEventNewSecretFindings `yaml:"new_secret_findings,omitempty"`
}
type NotificationTargetEmail ¶ added in v1.9.0
type NotificationTargetSlack ¶ added in v1.9.0
type NotificationTargetWebhook ¶ added in v1.9.0
type NotificationTargets ¶ added in v1.9.0
type NotificationTargets struct {
Webhook *NotificationTargetWebhook `yaml:"webhook,omitempty"`
Email *NotificationTargetEmail `yaml:"email,omitempty"`
Slack *NotificationTargetSlack `yaml:"slack,omitempty"`
}
type ScheduledNotification ¶ added in v1.10.0
type ScheduledNotification struct {
Schedule string `yaml:"schedule,omitempty"`
Topics ScheduledNotificationTopics `yaml:"topics,omitempty"`
Targets ScheduledNotificationTargets `yaml:"targets,omitempty"`
}
type ScheduledNotificationTargetEmail ¶ added in v1.10.0
type ScheduledNotificationTargetSlack ¶ added in v1.10.0
type ScheduledNotificationTargets ¶ added in v1.10.0
type ScheduledNotificationTargets struct {
Email *ScheduledNotificationTargetEmail `yaml:"email,omitempty"`
Slack *ScheduledNotificationTargetSlack `yaml:"slack,omitempty"`
}
type ScheduledNotificationTopics ¶ added in v1.10.0
type ScheduledNotificationTopics struct {
All bool `yaml:"all,omitempty"`
AllNewFindings bool `yaml:"all_new_findings,omitempty"`
NewAPIFindings bool `yaml:"new_api_findings,omitempty"`
NewCodeFindings bool `yaml:"new_code_findings,omitempty"`
NewCVEs bool `yaml:"new_cves,omitempty"`
NewSecrets bool `yaml:"new_secrets,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.