models

Documentation

Index

• Constants
• func Int(i int) *int
• type AutoFix
• type AutoFixPullRequestCreationRate
• type Code
• type CodeIgnore
• type Configuration
  • func (c *Configuration) GetFailBuilds() bool
• type Dependencies
• type DependenciesIgnore
• type Integrations
• type Jira
• type Notification
• type NotificationEventAll
• type NotificationEventNewAPIFindings
• type NotificationEventNewCodeFindings
• type NotificationEventNewDependencyFindings
• type NotificationEventNewSecretFindings
• type NotificationEvents
• type NotificationTargetEmail
• type NotificationTargetSlack
• type NotificationTargetWebhook
• type NotificationTargets
• type Priorities
• type ScheduledNotification
• type ScheduledNotificationTargetEmail
• type ScheduledNotificationTargetSlack
• type ScheduledNotificationTargets
• type ScheduledNotificationTopics
• type Secrets
• type SecretsIgnore

Constants

const (
	ScheduledNotificationTopicTypeAll          = "all"
	ScheduledNotificationTopicTypeCode         = "code"
	ScheduledNotificationTopicTypeIaC          = "iac"
	ScheduledNotificationTopicTypeDependencies = "dependencies"
	ScheduledNotificationTopicTypeSecrets      = "secrets"
	ScheduledNotificationTopicTypeDAST         = "dast"
)

const (
	SeverityCritical = "CRITICAL"
	SeverityHigh     = "HIGH"
	SeverityMedium   = "MEDIUM"
	SeverityLow      = "LOW"
	SeverityUnknown  = "UNKNOWN"
)

Functions

func Int

func Int(i int) *int

Types

type AutoFix

type AutoFix struct {
	Enabled                    bool                            `yaml:"enabled,omitempty"`
	MaxPullRequestsOpen        *int                            `yaml:"max_pull_requests_open,omitempty"`
	MaxPullRequestCreationRate *AutoFixPullRequestCreationRate `yaml:"max_pull_request_creation_rate,omitempty"`
}

type AutoFixPullRequestCreationRate

type AutoFixPullRequestCreationRate struct {
	Count int `yaml:"count,omitempty"`
	Days  int `yaml:"days,omitempty"`
}

type Code

type Code struct {
	AutoFix *AutoFix     `yaml:"auto_fix,omitempty"`
	Ignore  []CodeIgnore `yaml:"ignore,omitempty"`
}

type CodeIgnore

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"`
	Paths   []string `yaml:"paths,omitempty"`

	// global config only
	Repositories []string `yaml:"repositories,omitempty"`
}

type Configuration

type Configuration struct {
	FailBuilds        *bool    `yaml:"fail_builds,omitempty"`
	SeverityThreshold string   `yaml:"severity_threshold,omitempty"`
	IgnoreDirs        []string `yaml:"ignore_dirs,omitempty"`
	IgnorePaths       []string `yaml:"ignore_paths,omitempty"`

	Code         Code         `yaml:"code,omitempty"`
	Dependencies Dependencies `yaml:"dependencies,omitempty"`
	Secrets      Secrets      `yaml:"secrets,omitempty"`

	Notifications          map[string]Notification          `yaml:"notifications,omitempty"`
	ScheduledNotifications map[string]ScheduledNotification `yaml:"scheduled_notifications,omitempty"`
	Integrations           Integrations                     `yaml:"integrations,omitempty"`

	// TODO deprecate
	SecretsWhitelist []string `yaml:"secrets_whitelist,omitempty"`
}

func (*Configuration) GetFailBuilds

func (c *Configuration) GetFailBuilds() bool

type Dependencies

type Dependencies struct {
	AutoFix *AutoFix             `yaml:"auto_fix,omitempty"`
	Ignore  []DependenciesIgnore `yaml:"ignore,omitempty"`
}

type DependenciesIgnore

type DependenciesIgnore struct {
	Reason string `yaml:"reason,omitempty"`
	Expiry string `yaml:"expiry,omitempty"`

	// matchers
	CVEs  []string `yaml:"cves,omitempty"`
	Dirs  []string `yaml:"dirs,omitempty"`
	Paths []string `yaml:"paths,omitempty"`

	// global config only
	Repositories []string `yaml:"repositories,omitempty"`
}

type Integrations

type Integrations struct {
	Jira *Jira `yaml:"jira,omitempty"`
}

type Jira

type Jira struct {
	Disabled          bool        `yaml:"disabled,omitempty"`
	ProjectKey        string      `yaml:"project_key,omitempty"`
	IssueType         string      `yaml:"issue_type,omitempty"`
	SeverityThreshold string      `yaml:"severity_threshold,omitempty"`
	OnFixTransition   string      `yaml:"on_fix_transition,omitempty"`
	Priorities        *Priorities `yaml:"priorities,omitempty"`
}

type Notification

type Notification struct {
	Events  NotificationEvents  `yaml:"events,omitempty"`
	Targets NotificationTargets `yaml:"targets,omitempty"`

	// global config only
	Repositories []string `yaml:"repositories,omitempty"`
}

type NotificationEventAll

type NotificationEventAll struct {
	MinimumSeverity string   `yaml:"minimum_severity,omitempty"`
	MinimumPriority int      `yaml:"minimum_priority,omitempty"`
	CWEs            []int    `yaml:"cwes,omitempty"`
	CVEs            []string `yaml:"cves,omitempty"`
	SecretTypes     []string `yaml:"secret_types,omitempty"`
}

type NotificationEventNewAPIFindings

type NotificationEventNewAPIFindings struct {
	MinimumSeverity string `yaml:"minimum_severity,omitempty"`
	MinimumPriority int    `yaml:"minimum_priority,omitempty"`
	CWEs            []int  `yaml:"cwes,omitempty"`
}

type NotificationEventNewCodeFindings

type NotificationEventNewCodeFindings struct {
	MinimumSeverity string `yaml:"minimum_severity,omitempty"`
	MinimumPriority int    `yaml:"minimum_priority,omitempty"`
	CWEs            []int  `yaml:"cwes,omitempty"`
}

type NotificationEventNewDependencyFindings

type NotificationEventNewDependencyFindings struct {
	MinimumSeverity string   `yaml:"minimum_severity,omitempty"`
	MinimumPriority int      `yaml:"minimum_priority,omitempty"`
	CWEs            []int    `yaml:"cwes,omitempty"`
	CVEs            []string `yaml:"cves,omitempty"`
}

type NotificationEventNewSecretFindings

type NotificationEventNewSecretFindings struct {
	Types []string `yaml:"types,omitempty"`
}

type NotificationEvents

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

type NotificationTargetEmail struct {
	Address   string   `yaml:"address,omitempty"`
	Addresses []string `yaml:"addresses,omitempty"`
}

type NotificationTargetSlack

type NotificationTargetSlack struct {
	Channel  string   `yaml:"channel,omitempty"`
	Channels []string `yaml:"channels,omitempty"`
}

type NotificationTargetWebhook

type NotificationTargetWebhook struct {
	URLs []string `yaml:"urls,omitempty"`
	URL  string   `yaml:"url,omitempty"`
}

type NotificationTargets

type NotificationTargets struct {
	Webhook *NotificationTargetWebhook `yaml:"webhook,omitempty"`
	Email   *NotificationTargetEmail   `yaml:"email,omitempty"`
	Slack   *NotificationTargetSlack   `yaml:"slack,omitempty"`
}

type Priorities

type Priorities struct {
	Critical string `yaml:"critical,omitempty"`
	High     string `yaml:"high,omitempty"`
	Medium   string `yaml:"medium,omitempty"`
	Low      string `yaml:"low,omitempty"`
}

Mapping of Nullify Finding severities to Jira Priorities. The user can specify the priority of the issue based on the severity.

type ScheduledNotification

type ScheduledNotification struct {
	Schedule string                       `yaml:"schedule,omitempty"`
	Timezone string                       `yaml:"timezone,omitempty"`
	Topics   ScheduledNotificationTopics  `yaml:"topics,omitempty"`
	Targets  ScheduledNotificationTargets `yaml:"targets,omitempty"`

	// global config only
	Repositories []string `yaml:"repositories,omitempty"`
}

type ScheduledNotificationTargetEmail

type ScheduledNotificationTargetEmail struct {
	Address   string   `yaml:"address,omitempty"`
	Addresses []string `yaml:"addresses,omitempty"`
}

type ScheduledNotificationTargetSlack

type ScheduledNotificationTargetSlack struct {
	Channel  string   `yaml:"channel,omitempty"`
	Channels []string `yaml:"channels,omitempty"`
}

type ScheduledNotificationTargets

type ScheduledNotificationTargets struct {
	Email *ScheduledNotificationTargetEmail `yaml:"email,omitempty"`
	Slack *ScheduledNotificationTargetSlack `yaml:"slack,omitempty"`
}

type ScheduledNotificationTopics

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"`
}

type Secrets

type Secrets struct {
	Ignore []SecretsIgnore `yaml:"ignore,omitempty"`
}

type SecretsIgnore

type SecretsIgnore struct {
	Reason string `yaml:"reason,omitempty"`
	Expiry string `yaml:"expiry,omitempty"`

	// matchers
	Value   string `yaml:"value,omitempty"`
	Pattern string `yaml:"pattern,omitempty"`

	// global config only
	Repositories []string `yaml:"repositories,omitempty"`
}