types

package
v0.69.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 4, 2026 License: Apache-2.0 Imports: 9 Imported by: 178

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateFSKey 

func CreateFSKey(filesystem fs.FS) string

Types

type BaseValue added in v0.69.0 

type BaseValue[T any] struct {
	// contains filtered or unexported fields
}

func (BaseValue[T]) GetMetadata added in v0.69.0 

func (v BaseValue[T]) GetMetadata() Metadata

func (BaseValue[T]) GetRawValue added in v0.69.0 

func (v BaseValue[T]) GetRawValue() any

func (BaseValue[T]) MarshalJSON added in v0.69.0 

func (v BaseValue[T]) MarshalJSON() ([]byte, error)

func (BaseValue[T]) ToRego added in v0.69.0 

func (v BaseValue[T]) ToRego() any

func (*BaseValue[T]) UnmarshalJSON added in v0.69.0 

func (v *BaseValue[T]) UnmarshalJSON(data []byte) error

func (BaseValue[T]) Value added in v0.69.0 

func (v BaseValue[T]) Value() T

type BoolValue 

type BoolValue struct {
	BaseValue[bool]
}

func Bool 

func Bool(value bool, m Metadata) BoolValue

func BoolDefault 

func BoolDefault(value bool, m Metadata) BoolValue

func BoolExplicit 

func BoolExplicit(value bool, m Metadata) BoolValue

func BoolFromCtyValue added in v0.68.0 

func BoolFromCtyValue(val cty.Value, metadata Metadata) (BoolValue, bool)

BoolFromCtyValue converts a cty.Value to iacTypes.BoolValue. Returns the BoolValue and true if conversion to bool succeeded.

func BoolTest added in v0.51.0 

func BoolTest(value bool) BoolValue

func BoolUnresolvable 

func BoolUnresolvable(m Metadata) BoolValue

func (BoolValue) Invert added in v0.68.0 

func (b BoolValue) Invert() BoolValue

func (BoolValue) IsFalse 

func (b BoolValue) IsFalse() bool

func (BoolValue) IsTrue 

func (b BoolValue) IsTrue() bool

type BytesValue 

type BytesValue struct {
	BaseValue[[]byte]
}

func Bytes 

func Bytes(value []byte, m Metadata) BytesValue

func BytesDefault 

func BytesDefault(value []byte, m Metadata) BytesValue

func BytesExplicit 

func BytesExplicit(value []byte, m Metadata) BytesValue

func BytesTest added in v0.69.0 

func BytesTest(value []byte) BytesValue

func BytesUnresolvable 

func BytesUnresolvable(m Metadata) BytesValue

func (BytesValue) Len 

func (v BytesValue) Len() int

func (BytesValue) ToRego 

func (v BytesValue) ToRego() any

type Command added in v0.53.0 

type Command struct {
	ID string `yaml:"id"`
}

type ComplianceSpec 

type ComplianceSpec struct {
	Spec Spec `yaml:"spec"`
}

ComplianceSpec represent the compliance specification

type Control 

type Control struct {
	ID            string        `yaml:"id"`
	Name          string        `yaml:"name"`
	Description   string        `yaml:"description,omitempty"`
	Checks        []SpecCheck   `yaml:"checks,omitempty"`
	Commands      []Command     `yaml:"commands,omitempty"`
	Severity      Severity      `yaml:"severity"`
	DefaultStatus ControlStatus `yaml:"defaultStatus,omitempty"`
}

Control represent the cps controls data and mapping checks

type ControlStatus 

type ControlStatus string

type IntValue 

type IntValue struct {
	BaseValue[int]
}

func Int 

func Int(value int, m Metadata) IntValue

func IntDefault 

func IntDefault(value int, m Metadata) IntValue

func IntExplicit 

func IntExplicit(value int, m Metadata) IntValue

func IntTest added in v0.51.0 

func IntTest(value int) IntValue

func IntUnresolvable 

func IntUnresolvable(m Metadata) IntValue

func (IntValue) EqualTo 

func (b IntValue) EqualTo(i int) bool

func (IntValue) GreaterThan 

func (b IntValue) GreaterThan(i int) bool

func (IntValue) LessThan 

func (b IntValue) LessThan(i int) bool

type MapValue 

type MapValue struct {
	BaseValue[map[string]string]
}

func Map 

func Map(value map[string]string, m Metadata) MapValue

func MapDefault 

func MapDefault(value map[string]string, m Metadata) MapValue

func MapExplicit 

func MapExplicit(value map[string]string, m Metadata) MapValue

func MapTest added in v0.69.0 

func MapTest(value map[string]string) MapValue

func (MapValue) GetRawValue 

func (b MapValue) GetRawValue() any

func (MapValue) HasKey 

func (b MapValue) HasKey(key string) bool

func (MapValue) Len 

func (b MapValue) Len() int

func (MapValue) Value 

func (b MapValue) Value() map[string]string

type Metadata 

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

func NewApiMetadata 

func NewApiMetadata(provider string, parts ...string) Metadata

func NewExplicitMetadata 

func NewExplicitMetadata(r Range, ref string) Metadata

func NewMetadata 

func NewMetadata(r Range, ref string) Metadata

func NewRemoteMetadata 

func NewRemoteMetadata(id string) Metadata

func NewTestMetadata 

func NewTestMetadata() Metadata

func NewUnmanagedMetadata 

func NewUnmanagedMetadata() Metadata

func NewUnresolvableMetadata 

func NewUnresolvableMetadata(r Range, ref string) Metadata

func (Metadata) GetMetadata 

func (m Metadata) GetMetadata() Metadata

func (Metadata) GetRawValue 

func (m Metadata) GetRawValue() any

func (Metadata) Internal 

func (m Metadata) Internal() any

func (Metadata) IsDefault 

func (m Metadata) IsDefault() bool

func (Metadata) IsExplicit 

func (m Metadata) IsExplicit() bool

func (Metadata) IsManaged 

func (m Metadata) IsManaged() bool

func (Metadata) IsMultiLine 

func (m Metadata) IsMultiLine() bool

func (Metadata) IsResolvable 

func (m Metadata) IsResolvable() bool

func (Metadata) IsUnmanaged 

func (m Metadata) IsUnmanaged() bool

func (Metadata) MarshalJSON 

func (m Metadata) MarshalJSON() ([]byte, error)

func (Metadata) Parent 

func (m Metadata) Parent() *Metadata

func (Metadata) Range 

func (m Metadata) Range() Range

func (Metadata) Reference 

func (m Metadata) Reference() string

func (Metadata) Root 

func (m Metadata) Root() Metadata

func (*Metadata) SetParentPtr 

func (m *Metadata) SetParentPtr(p *Metadata)

func (*Metadata) SetRange 

func (m *Metadata) SetRange(r Range)

func (*Metadata) SetReference 

func (m *Metadata) SetReference(ref string)

func (Metadata) String 

func (m Metadata) String() string

func (*Metadata) ToRego 

func (m *Metadata) ToRego() any

func (*Metadata) UnmarshalJSON 

func (m *Metadata) UnmarshalJSON(data []byte) error

func (Metadata) WithInternal 

func (m Metadata) WithInternal(internal any) Metadata

func (Metadata) WithParent 

func (m Metadata) WithParent(p Metadata) Metadata

type RFC3339Time added in v0.69.0 

type RFC3339Time struct {
	time.Time
}

func (RFC3339Time) MarshalJSON added in v0.69.0 

func (t RFC3339Time) MarshalJSON() ([]byte, error)

func (*RFC3339Time) UnmarshalJSON added in v0.69.0 

func (t *RFC3339Time) UnmarshalJSON(data []byte) error

type Range 

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

func NewRange 

func NewRange(filename string, startLine, endLine int, sourcePrefix string, srcFS fs.FS) Range

func NewRangeWithFSKey 

func NewRangeWithFSKey(filename string, startLine, endLine int, sourcePrefix, fsKey string, fsys fs.FS) Range

func NewRangeWithLogicalSource 

func NewRangeWithLogicalSource(filename string, startLine, endLine int, sourcePrefix string, srcFS fs.FS) Range

func (Range) Covers added in v0.60.0 

func (r Range) Covers(other Range) bool

Covers returns true if 'r' fully contains 'other'.

func (Range) GetEndLine 

func (r Range) GetEndLine() int

func (Range) GetFS 

func (r Range) GetFS() fs.FS

func (Range) GetFSKey 

func (r Range) GetFSKey() string

func (Range) GetFilename 

func (r Range) GetFilename() string

func (Range) GetLocalFilename 

func (r Range) GetLocalFilename() string

func (Range) GetSourcePrefix 

func (r Range) GetSourcePrefix() string

func (Range) GetStartLine 

func (r Range) GetStartLine() int

func (Range) Includes added in v0.60.0 

func (r Range) Includes(other Range) bool

Includes returns true if 'other' is strictly inside 'r'.

func (Range) IsMultiLine 

func (r Range) IsMultiLine() bool

func (Range) LineCount 

func (r Range) LineCount() int

func (Range) MarshalJSON 

func (r Range) MarshalJSON() ([]byte, error)

func (Range) String 

func (r Range) String() string

func (*Range) UnmarshalJSON 

func (r *Range) UnmarshalJSON(data []byte) error

func (Range) Validate added in v0.55.0 

func (r Range) Validate() error

type Severity 

type Severity string

type Source 

type Source string
const (
	SourceDockerfile Source = "dockerfile"
	SourceKubernetes Source = "kubernetes"
	// Deprecated: use "kubernetes" instead
	SourceRbac Source = "rbac"
	// Deprecated: use "cloud" instead
	SourceDefsec       Source = "defsec"
	SourceCloud        Source = "cloud"
	SourceYAML         Source = "yaml"
	SourceJSON         Source = "json"
	SourceTOML         Source = "toml"
	SourceTerraformRaw Source = "terraform-raw"
)

type Spec 

type Spec struct {
	ID               string    `yaml:"id"`
	Title            string    `yaml:"title"`
	Description      string    `yaml:"description"`
	Version          string    `yaml:"version"`
	Platform         string    `yaml:"platform"`
	Type             string    `yaml:"type"`
	RelatedResources []string  `yaml:"relatedResources,omitempty"`
	Controls         []Control `yaml:"controls"`
}

type SpecCheck 

type SpecCheck struct {
	ID string `yaml:"id"`
}

SpecCheck represent the scanner who perform the control check

type StringValue 

type StringValue struct {
	BaseValue[string]
}

func String 

func String(value string, m Metadata) StringValue

func StringDefault 

func StringDefault(value string, m Metadata) StringValue

func StringExplicit 

func StringExplicit(value string, m Metadata) StringValue

func StringTest added in v0.51.0 

func StringTest(value string) StringValue

func StringUnresolvable 

func StringUnresolvable(m Metadata) StringValue

func (StringValue) Contains 

func (s StringValue) Contains(value string) bool

func (StringValue) EndsWith 

func (s StringValue) EndsWith(suffix string) bool

func (StringValue) EqualTo 

func (s StringValue) EqualTo(value string) bool

func (StringValue) IsEmpty 

func (s StringValue) IsEmpty() bool

func (StringValue) IsNotEmpty 

func (s StringValue) IsNotEmpty() bool

func (StringValue) IsOneOf 

func (s StringValue) IsOneOf(values ...string) bool

func (StringValue) NotEqualTo 

func (s StringValue) NotEqualTo(value string) bool

func (StringValue) StartsWith 

func (s StringValue) StartsWith(prefix string) bool

type StringValueList 

type StringValueList []StringValue

func (StringValueList) AsStrings 

func (l StringValueList) AsStrings() (output []string)

type TimeValue 

type TimeValue struct {
	BaseValue[RFC3339Time]
}

func Time 

func Time(value time.Time, m Metadata) TimeValue

func TimeDefault 

func TimeDefault(value time.Time, m Metadata) TimeValue

func TimeExplicit 

func TimeExplicit(value time.Time, m Metadata) TimeValue

func TimeTest added in v0.69.0 

func TimeTest(value time.Time) TimeValue

func TimeUnresolvable 

func TimeUnresolvable(m Metadata) TimeValue

func (TimeValue) After 

func (t TimeValue) After(i time.Time) bool

func (TimeValue) Before 

func (t TimeValue) Before(i time.Time) bool

func (TimeValue) GetRawValue 

func (t TimeValue) GetRawValue() any

func (TimeValue) IsNever 

func (t TimeValue) IsNever() bool

func (TimeValue) ToRego 

func (t TimeValue) ToRego() any

func (TimeValue) Value 

func (t TimeValue) Value() time.Time

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.