cautils

Documentation

Index

• Constants
• Variables
• func ConvertLabelsToString(labels map[string]string) string
• func ConvertStringToLabels(labelsStr string) map[string]string
• func ErrorDisplay(str string)
• func GetValueFromConfigJson(key string) (string, error)
• func IsSilent() bool
• func PrettyJson(data interface{}) ([]byte, error)
• func ProgressTextDisplay(str string)
• func ScanStartDisplay()
• func SetKeyValueInConfigJson(key string, value string) error
• func SetSilentMode(s bool)
• func StartSpinner()
• func StopSpinner()
• func StringInSlice(strSlice []string, str string) int
• func SuccessTextDisplay(str string)
• type ClusterConfig
  • func NewClusterConfig(k8s *k8sinterface.KubernetesApi, armoAPI *getter.ArmoAPI) *ClusterConfig
  • func (c *ClusterConfig) GenerateURL()
  • func (c *ClusterConfig) GetCustomerGUID() string
  • func (c *ClusterConfig) GetValueByKeyFromConfigMap(key string) (string, error)
  • func (c *ClusterConfig) SetCustomerGUID() error
  • func (c *ClusterConfig) SetKeyValueInConfigmap(key string, value string) error
  • func (c *ClusterConfig) ToMapString() map[string]interface{}
• type ComponentConfig
• type ConfigObj
  • func (co *ConfigObj) Json() []byte
• type DownloadInfo
• type EmptyConfig
  • func NewEmptyConfig() *EmptyConfig
  • func (c *EmptyConfig) GenerateURL()
  • func (c *EmptyConfig) GetCustomerGUID() string
  • func (c *EmptyConfig) SetCustomerGUID() error
• type Exception
• type Getters
• type IClusterConfig
• type K8SResources
• type OPASessionObj
  • func NewOPASessionObj(frameworks []opapolicy.Framework, k8sResources *K8SResources) *OPASessionObj
  • func NewOPASessionObjMock() *OPASessionObj
• type ScanInfo
  • func (scanInfo *ScanInfo) Init()
  • func (scanInfo *ScanInfo) ScanRunningCluster() bool

Constants

const (
	ComponentIdentifier = "Posture"
)

const (
	ConfigFileName = "config"
)

const ValueNotFound = -1

Variables

var (
	CustomerGUID          = ""
	ClusterName           = ""
	EventReceiverURL      = ""
	NotificationServerURL = ""
	DashboardBackendURL   = ""
	RestAPIPort           = "4001"
)

CA environment vars

var DescriptionDisplay = color.New(color.Faint, color.FgWhite).FprintfFunc()

var FailureDisplay = color.New(color.Bold, color.FgHiRed).FprintfFunc()

var FailureTextDisplay = color.New(color.Faint, color.FgHiRed).FprintfFunc()

var InfoDisplay = color.New(color.Bold, color.FgHiYellow).FprintfFunc()

var InfoTextDisplay = color.New(color.Faint, color.FgHiYellow).FprintfFunc()

var SimpleDisplay = color.New(color.Bold, color.FgHiWhite).FprintfFunc()

var Spinner *spinner.Spinner

var SuccessDisplay = color.New(color.Bold, color.FgHiGreen).FprintfFunc()

var WarningDisplay = color.New(color.Bold, color.FgCyan).FprintfFunc()

Functions

func ConvertLabelsToString

func ConvertLabelsToString(labels map[string]string) string

func ConvertStringToLabels

func ConvertStringToLabels(labelsStr string) map[string]string

ConvertStringToLabels convert a string "a=b;c=d" to map: {"a":"b", "c":"d"}

func ErrorDisplay

func ErrorDisplay(str string)

func GetValueFromConfigJson

func GetValueFromConfigJson(key string) (string, error)

func IsSilent

func IsSilent() bool

func PrettyJson

func PrettyJson(data interface{}) ([]byte, error)

func ProgressTextDisplay

func ProgressTextDisplay(str string)

func ScanStartDisplay

func ScanStartDisplay()

func SetKeyValueInConfigJson

func SetKeyValueInConfigJson(key string, value string) error

func SetSilentMode

func SetSilentMode(s bool)

func StartSpinner

func StartSpinner()

func StopSpinner

func StopSpinner()

func StringInSlice

func StringInSlice(strSlice []string, str string) int

func SuccessTextDisplay

func SuccessTextDisplay(str string)

Types

type ClusterConfig

type ClusterConfig struct {
	// contains filtered or unexported fields
}

func NewClusterConfig

func NewClusterConfig(k8s *k8sinterface.KubernetesApi, armoAPI *getter.ArmoAPI) *ClusterConfig

func (*ClusterConfig) GenerateURL

func (c *ClusterConfig) GenerateURL()

func (*ClusterConfig) GetCustomerGUID

func (c *ClusterConfig) GetCustomerGUID() string

func (*ClusterConfig) GetValueByKeyFromConfigMap

func (c *ClusterConfig) GetValueByKeyFromConfigMap(key string) (string, error)

func (*ClusterConfig) SetCustomerGUID

func (c *ClusterConfig) SetCustomerGUID() error

func (*ClusterConfig) SetKeyValueInConfigmap

func (c *ClusterConfig) SetKeyValueInConfigmap(key string, value string) error

func (*ClusterConfig) ToMapString

func (c *ClusterConfig) ToMapString() map[string]interface{}

type ComponentConfig

type ComponentConfig struct {
	Exceptions Exception `json:"exceptions"`
}

type ConfigObj

type ConfigObj struct {
	CustomerGUID       string `json:"customerGUID"`
	Token              string `json:"invitationParam"`
	CustomerAdminEMail string `json:"adminMail"`
}

func (*ConfigObj) Json

func (co *ConfigObj) Json() []byte

type DownloadInfo

type DownloadInfo struct {
	Path          string
	FrameworkName string
}

type EmptyConfig

type EmptyConfig struct {
}

func NewEmptyConfig

func NewEmptyConfig() *EmptyConfig

func (*EmptyConfig) GenerateURL

func (c *EmptyConfig) GenerateURL()

func (*EmptyConfig) GetCustomerGUID

func (c *EmptyConfig) GetCustomerGUID() string

func (*EmptyConfig) SetCustomerGUID

func (c *EmptyConfig) SetCustomerGUID() error

type Exception

type Exception struct {
	Ignore        *bool                 `json:"ignore"`        // ignore test results
	MultipleScore *opapolicy.AlertScore `json:"multipleScore"` // MultipleScore number - float32
	Namespaces    []string              `json:"namespaces"`
	Regex         string                `json:"regex"` // not supported
}

type Getters

type Getters struct {
	ExceptionsGetter getter.IExceptionsGetter
	PolicyGetter     getter.IPolicyGetter
}

type IClusterConfig

type IClusterConfig interface {
	SetCustomerGUID() error
	GetCustomerGUID() string
	GenerateURL()
}

type K8SResources

type K8SResources map[string]interface{}

K8SResources map[<api group>/<api version>/<resource>]<resource object>

type OPASessionObj

type OPASessionObj struct {
	Frameworks    []opapolicy.Framework
	K8SResources  *K8SResources
	Exceptions    []armotypes.PostureExceptionPolicy
	PostureReport *opapolicy.PostureReport
}

func NewOPASessionObj

func NewOPASessionObj(frameworks []opapolicy.Framework, k8sResources *K8SResources) *OPASessionObj

func NewOPASessionObjMock

func NewOPASessionObjMock() *OPASessionObj

type ScanInfo

type ScanInfo struct {
	Getters
	PolicyIdentifier   opapolicy.PolicyIdentifier
	UseExceptions      string
	UseFrom            string
	UseDefault         bool
	Format             string
	Output             string
	ExcludedNamespaces string
	InputPatterns      []string
	Silent             bool
	FailThreshold      uint16
	DoNotSendResults   bool
}

func (*ScanInfo) Init

func (scanInfo *ScanInfo) Init()

func (*ScanInfo) ScanRunningCluster

func (scanInfo *ScanInfo) ScanRunningCluster() bool