posture

Documentation

Index

• Constants
• type Check
• type Checks
  • func NewChecksFromAPIPostureCheck(source api.PostureCheck) (*Checks, error)
  • func NewChecksFromAPIPostureCheckUpdate(source api.PostureCheckUpdate, postureChecksID string) (*Checks, error)
  • func (pc *Checks) Copy() *Checks
  • func (pc *Checks) EventMeta() map[string]any
  • func (pc *Checks) GetChecks() []Check
  • func (*Checks) TableName() string
  • func (pc *Checks) ToAPIResponse() *api.PostureCheck
  • func (pc *Checks) Validate() error
• type ChecksDefinition
  • func (cd ChecksDefinition) Copy() ChecksDefinition
• type GeoLocationCheck
  • func (g *GeoLocationCheck) Check(_ context.Context, peer nbpeer.Peer) (bool, error)
  • func (g *GeoLocationCheck) Name() string
  • func (g *GeoLocationCheck) Validate() error
• type Location
• type MinKernelVersionCheck
• type MinVersionCheck
• type NBVersionCheck
  • func (n *NBVersionCheck) Check(ctx context.Context, peer nbpeer.Peer) (bool, error)
  • func (n *NBVersionCheck) Name() string
  • func (n *NBVersionCheck) Validate() error
• type OSVersionCheck
  • func (c *OSVersionCheck) Check(ctx context.Context, peer nbpeer.Peer) (bool, error)
  • func (c *OSVersionCheck) Name() string
  • func (c *OSVersionCheck) Validate() error
• type PeerNetworkRangeCheck
  • func (p *PeerNetworkRangeCheck) Check(ctx context.Context, peer nbpeer.Peer) (bool, error)
  • func (p *PeerNetworkRangeCheck) Name() string
  • func (p *PeerNetworkRangeCheck) Validate() error
• type Process
• type ProcessCheck
  • func (p *ProcessCheck) Check(_ context.Context, peer nbpeer.Peer) (bool, error)
  • func (p *ProcessCheck) Name() string
  • func (p *ProcessCheck) Validate() error

Constants

const (
	NBVersionCheckName        = "NBVersionCheck"
	OSVersionCheckName        = "OSVersionCheck"
	GeoLocationCheckName      = "GeoLocationCheck"
	PeerNetworkRangeCheckName = "PeerNetworkRangeCheck"
	ProcessCheckName          = "ProcessCheck"

	CheckActionAllow string = "allow"
	CheckActionDeny  string = "deny"
)

Types

type Check

type Check interface {
	Name() string
	Check(ctx context.Context, peer nbpeer.Peer) (bool, error)
	Validate() error
}

Check represents an interface for performing a check on a peer.

type Checks

type Checks struct {
	// ID of the posture checks
	ID string `gorm:"primaryKey"`

	// Name of the posture checks
	Name string

	// Description of the posture checks visible in the UI
	Description string

	// AccountID is a reference to the Account that this object belongs
	AccountID string `json:"-" gorm:"index"`

	// Checks is a set of objects that perform the actual checks
	Checks ChecksDefinition `gorm:"serializer:json"`
}

func NewChecksFromAPIPostureCheck

func NewChecksFromAPIPostureCheck(source api.PostureCheck) (*Checks, error)

func NewChecksFromAPIPostureCheckUpdate

func NewChecksFromAPIPostureCheckUpdate(source api.PostureCheckUpdate, postureChecksID string) (*Checks, error)

func (*Checks) Copy

func (pc *Checks) Copy() *Checks

Copy returns a copy of a posture checks.

func (*Checks) EventMeta

func (pc *Checks) EventMeta() map[string]any

EventMeta returns activity event meta-related to this posture checks.

func (*Checks) GetChecks

func (pc *Checks) GetChecks() []Check

GetChecks returns list of all initialized checks definitions

func (*Checks) TableName

func (*Checks) TableName() string

TableName returns the name of the table for the Checks model in the database.

func (*Checks) ToAPIResponse

func (pc *Checks) ToAPIResponse() *api.PostureCheck

func (*Checks) Validate

func (pc *Checks) Validate() error

Validate checks the validity of a posture checks.

type ChecksDefinition

type ChecksDefinition struct {
	NBVersionCheck        *NBVersionCheck        `json:",omitempty"`
	OSVersionCheck        *OSVersionCheck        `json:",omitempty"`
	GeoLocationCheck      *GeoLocationCheck      `json:",omitempty"`
	PeerNetworkRangeCheck *PeerNetworkRangeCheck `json:",omitempty"`
	ProcessCheck          *ProcessCheck          `json:",omitempty"`
}

ChecksDefinition contains definition of actual check

func (ChecksDefinition) Copy

func (cd ChecksDefinition) Copy() ChecksDefinition

Copy returns a copy of a checks definition.

type GeoLocationCheck

type GeoLocationCheck struct {
	// Locations list of geolocations, to which the policy applies
	Locations []Location

	// Action to take upon policy match
	Action string
}

func (*GeoLocationCheck) Check

func (g *GeoLocationCheck) Check(_ context.Context, peer nbpeer.Peer) (bool, error)

func (*GeoLocationCheck) Name

func (g *GeoLocationCheck) Name() string

func (*GeoLocationCheck) Validate

func (g *GeoLocationCheck) Validate() error

type Location

type Location struct {
	// CountryCode 2-letter ISO 3166-1 alpha-2 code that represents the country
	CountryCode string

	// CityName Commonly used English name of the city
	CityName string
}

type MinKernelVersionCheck

type MinKernelVersionCheck struct {
	MinKernelVersion string
}

type MinVersionCheck

type MinVersionCheck struct {
	MinVersion string
}

type NBVersionCheck

type NBVersionCheck struct {
	MinVersion string
}

func (*NBVersionCheck) Check

func (n *NBVersionCheck) Check(ctx context.Context, peer nbpeer.Peer) (bool, error)

func (*NBVersionCheck) Name

func (n *NBVersionCheck) Name() string

func (*NBVersionCheck) Validate

func (n *NBVersionCheck) Validate() error

type OSVersionCheck

type OSVersionCheck struct {
	Android *MinVersionCheck
	Darwin  *MinVersionCheck
	Ios     *MinVersionCheck
	Linux   *MinKernelVersionCheck
	Windows *MinKernelVersionCheck
}

func (*OSVersionCheck) Check

func (c *OSVersionCheck) Check(ctx context.Context, peer nbpeer.Peer) (bool, error)

func (*OSVersionCheck) Name

func (c *OSVersionCheck) Name() string

func (*OSVersionCheck) Validate

func (c *OSVersionCheck) Validate() error

type PeerNetworkRangeCheck

type PeerNetworkRangeCheck struct {
	Action string
	Ranges []netip.Prefix `gorm:"serializer:json"`
}

func (*PeerNetworkRangeCheck) Check

func (p *PeerNetworkRangeCheck) Check(ctx context.Context, peer nbpeer.Peer) (bool, error)

func (*PeerNetworkRangeCheck) Name

func (p *PeerNetworkRangeCheck) Name() string

func (*PeerNetworkRangeCheck) Validate

func (p *PeerNetworkRangeCheck) Validate() error

type Process

type Process struct {
	LinuxPath   string
	MacPath     string
	WindowsPath string
}

type ProcessCheck

type ProcessCheck struct {
	Processes []Process
}

func (*ProcessCheck) Check

func (p *ProcessCheck) Check(_ context.Context, peer nbpeer.Peer) (bool, error)

func (*ProcessCheck) Name

func (p *ProcessCheck) Name() string

func (*ProcessCheck) Validate

func (p *ProcessCheck) Validate() error