sechub

Documentation

Index

• type Change
• type ChangeType
• type Controls
  • func (c *Controls) UnmarshalYAML(b []byte) error
• type FindingGroup
• type FindingGroups
  • func (fgs FindingGroups) ControlIDs() []string
  • func (fgs FindingGroups) FindByControlID(id string) (*FindingGroup, error)
• type FindingResource
• type FindingResources
  • func (frs FindingResources) Arns() []string
  • func (frs FindingResources) FindByArn(arn string) (*FindingResource, error)
• type Notification
• type Notifications
• type NotifyFinding
• type Regions
• type SecHub
  • func Diff(base, a *SecHub) (*SecHub, error)
  • func Intersect(a, b *SecHub) *SecHub
  • func Load(p string) (*SecHub, error)
  • func New(r string) *SecHub
  • func Override(base, a *SecHub) (*SecHub, error)
  • func (sh *SecHub) Apply(ctx context.Context, cfg aws.Config, reason string) error
  • func (sh *SecHub) Fetch(ctx context.Context, cfg aws.Config) error
  • func (s *SecHub) MarshalYAML() ([]byte, error)
  • func (sh *SecHub) Notify(ctx context.Context, cfg aws.Config, findings []NotifyFinding) error
  • func (base *SecHub) Overlay(overlay *SecHub)
  • func (sh *SecHub) Plan(ctx context.Context, cfg aws.Config, reason string) ([]*Change, error)
  • func (s *SecHub) UnmarshalYAML(b []byte) error
  • func (sh *SecHub) Validate() error
• type SecHubForUnmarshal
• type Standard
  • func (s *Standard) UnmarshalYAML(b []byte) error
• type StandardForUnmarshal
• type StandardForYAML
• type Standards

Types

type Change

type Change struct {
	Key            string
	ChangeType     ChangeType
	DisabledReason string
	Changed        interface{}
}

type ChangeType

type ChangeType string

const (
	ENABLE  ChangeType = "+"
	DISABLE ChangeType = "-"
	CHANGE  ChangeType = "~"
)

type Controls

type Controls struct {
	Enable  []string      `yaml:"enable,flow,omitempty"`
	Disable yaml.MapSlice `yaml:"disable,omitempty"`
	// contains filtered or unexported fields
}

func (*Controls) UnmarshalYAML

func (c *Controls) UnmarshalYAML(b []byte) error

type FindingGroup

type FindingGroup struct {
	ControlID string
	Resources FindingResources
}

type FindingGroups

type FindingGroups []*FindingGroup

func (FindingGroups) ControlIDs

func (fgs FindingGroups) ControlIDs() []string

func (FindingGroups) FindByControlID

func (fgs FindingGroups) FindByControlID(id string) (*FindingGroup, error)

type FindingResource

type FindingResource struct {
	Arn    string
	Status string
	Note   string
}

type FindingResources

type FindingResources []*FindingResource

func (FindingResources) Arns

func (frs FindingResources) Arns() []string

func (FindingResources) FindByArn

func (frs FindingResources) FindByArn(arn string) (*FindingResource, error)

type Notification

type Notification struct {
	If         string `yaml:"if"`
	Header     string `yaml:"header,omitempty"`
	Message    string `yaml:"message,omitempty"`
	WebhookURL string `yaml:"webhookURL"`
	Template   interface{}
}

type Notifications

type Notifications []*Notification

type NotifyFinding

type NotifyFinding struct {
	SeverityLabel  types.SeverityLabel
	WorkflowStatus types.WorkflowStatus
}

type Regions

type Regions []*SecHub

type SecHub

type SecHub struct {
	AutoEnable    *bool `yaml:"autoEnable,omitempty"`
	Standards     Standards
	Regions       Regions
	Notifications Notifications `yaml:"notifications,omitempty"`
	// contains filtered or unexported fields
}

func Diff

func Diff(base, a *SecHub) (*SecHub, error)

func Intersect

func Intersect(a, b *SecHub) *SecHub

func Load

func Load(p string) (*SecHub, error)

func New

func New(r string) *SecHub

func Override

func Override(base, a *SecHub) (*SecHub, error)

func (*SecHub) Apply

func (sh *SecHub) Apply(ctx context.Context, cfg aws.Config, reason string) error

func (*SecHub) Fetch

func (sh *SecHub) Fetch(ctx context.Context, cfg aws.Config) error

func (*SecHub) MarshalYAML

func (s *SecHub) MarshalYAML() ([]byte, error)

func (*SecHub) Notify

func (sh *SecHub) Notify(ctx context.Context, cfg aws.Config, findings []NotifyFinding) error

func (*SecHub) Overlay

func (base *SecHub) Overlay(overlay *SecHub)

func (*SecHub) Plan

func (sh *SecHub) Plan(ctx context.Context, cfg aws.Config, reason string) ([]*Change, error)

func (*SecHub) UnmarshalYAML

func (s *SecHub) UnmarshalYAML(b []byte) error

func (*SecHub) Validate

func (sh *SecHub) Validate() error

type SecHubForUnmarshal

type SecHubForUnmarshal struct {
	AutoEnable    *bool                          `yaml:"autoEnable,omitempty"`
	Standards     map[string]*Standard           `yaml:"standards,omitempty"`
	Regions       map[string]*SecHubForUnmarshal `yaml:"regions,omitempty"`
	Notifications Notifications                  `yaml:"notifications,omitempty"`
}

type Standard

type Standard struct {
	Key      string        `yaml:"key,omitempty"`
	Enable   *bool         `yaml:"enable,omitempty"`
	Controls *Controls     `yaml:"controls,omitempty"`
	Findings FindingGroups `yaml:"-"`
	// contains filtered or unexported fields
}

func (*Standard) UnmarshalYAML

func (s *Standard) UnmarshalYAML(b []byte) error

type StandardForUnmarshal

type StandardForUnmarshal struct {
	Key      string        `yaml:"key,omitempty"`
	Enable   *bool         `yaml:"enable,omitempty"`
	Controls *Controls     `yaml:"controls,omitempty"`
	Findings yaml.MapSlice `yaml:"findings,omitempty"`
}

type StandardForYAML

type StandardForYAML struct {
	Enable   *bool         `yaml:"enable,omitempty"`
	Controls *Controls     `yaml:"controls,omitempty"`
	Findings yaml.MapSlice `yaml:"findings,omitempty"`
}

type Standards

type Standards []*Standard