state

Documentation

Index

• Constants
• Variables
• type APMSamplingConfig
• type APMTracingConfig
• type ASMDataConfig
• type ASMDataRuleData
• type ASMDataRuleDataEntry
• type ASMDataRulesData
• type ASMFeaturesConfig
• type ASMFeaturesData
• type ApplyState
• type ApplyStatus
• type CachedFile
• type ConfigASMDD
• type ConfigCWSCustom
• type ConfigCWSDD
• type ConfigState
• type Metadata
• type Repository
  • func NewRepository(embeddedRoot []byte) (*Repository, error)
  • func NewUnverifiedRepository() (*Repository, error)
  • func (r *Repository) APMConfigs() map[string]APMSamplingConfig
  • func (r *Repository) APMTracingConfigs() map[string]APMTracingConfig
  • func (r *Repository) ASMDDConfigs() map[string]ConfigASMDD
  • func (r *Repository) ASMDataConfigs() map[string]ASMDataConfig
  • func (r *Repository) ASMFeaturesConfigs() map[string]ASMFeaturesConfig
  • func (r *Repository) CWSCustomConfigs() map[string]ConfigCWSCustom
  • func (r *Repository) CWSDDConfigs() map[string]ConfigCWSDD
  • func (r *Repository) CurrentState() (RepositoryState, error)
  • func (r *Repository) Update(update Update) ([]string, error)
  • func (r *Repository) UpdateApplyStatus(cfgPath string, status ApplyStatus)
• type RepositoryState
• type Update

Constants

const (
	// ProductAPMSampling is the apm sampling product
	ProductAPMSampling = "APM_SAMPLING"
	// ProductCWSDD is the cloud workload security product managed by datadog employees
	ProductCWSDD = "CWS_DD"
	// ProductCWSCustom is the cloud workload security product managed by datadog customers
	ProductCWSCustom = "CWS_CUSTOM"
	// ProductASMFeatures is the ASM product used form ASM activation through remote config
	ProductASMFeatures = "ASM_FEATURES"
	// ProductASMDD is the application security monitoring product managed by datadog employees
	ProductASMDD = "ASM_DD"
	// ProductASMData is the ASM product used to configure WAF rules data
	ProductASMData = "ASM_DATA"
	// ProductAPMTracing is the apm tracing product
	ProductAPMTracing = "APM_TRACING"
)

Variables

var (
	// ErrMalformedEmbeddedRoot occurs when the TUF root provided is invalid
	ErrMalformedEmbeddedRoot = errors.New("malformed embedded TUF root file provided")
)

var ErrNoConfigVersion = errors.New("version missing in custom file meta")

ErrNoConfigVersion occurs when a target file's custom meta is missing the config version

Types

type APMSamplingConfig

type APMSamplingConfig struct {
	Config   []byte
	Metadata Metadata
}

APMSamplingConfig is a deserialized APM Sampling configuration file along with its associated remote config metadata.

type APMTracingConfig

type APMTracingConfig struct {
	Config   []byte
	Metadata Metadata
}

type ASMDataConfig

type ASMDataConfig struct {
	Config   ASMDataRulesData
	Metadata Metadata
}

ASMDataConfig is a deserialized configuration file that holds rules data that can be used by the ASM WAF for specific features (example: ip blocking).

type ASMDataRuleData

type ASMDataRuleData struct {
	ID   string                 `json:"id"`
	Type string                 `json:"type"`
	Data []ASMDataRuleDataEntry `json:"data"`
}

ASMDataRuleData is an entry in the rules data list held by an ASMData configuration

type ASMDataRuleDataEntry

type ASMDataRuleDataEntry struct {
	Expiration int64  `json:"expiration,omitempty"`
	Value      string `json:"value"`
}

ASMDataRuleDataEntry represents a data entry in a rule data file

type ASMDataRulesData

type ASMDataRulesData struct {
	RulesData []ASMDataRuleData `json:"rules_data"`
}

ASMDataRulesData is a serializable array of rules data entries

type ASMFeaturesConfig

type ASMFeaturesConfig struct {
	Config   ASMFeaturesData
	Metadata Metadata
}

ASMFeaturesConfig is a deserialized configuration file that indicates whether ASM should be enabled within a tracer, along with its associated remote config metadata.

type ASMFeaturesData

type ASMFeaturesData struct {
	ASM struct {
		Enabled bool `json:"enabled"`
	} `json:"asm"`
}

ASMFeaturesData describes the enabled state of ASM features

type ApplyState

type ApplyState uint64

ApplyState represents the status of a configuration application by a remote configuration client Clients need to either ack the correct application of received configurations, or communicate that they haven't applied it yet, or communicate any error that may have happened while doing so

const (
	ApplyStateUnknown ApplyState = iota
	ApplyStateUnacknowledged
	ApplyStateAcknowledged
	ApplyStateError
)

type ApplyStatus

type ApplyStatus struct {
	State ApplyState
	Error string
}

ApplyStatus is the processing status for a given configuration. It basically represents whether a config was successfully processed and apply, or if an error occurred

type CachedFile

type CachedFile struct {
	Path   string
	Length uint64
	Hashes map[string][]byte
}

CachedFile describes a cached file stored by the agent client

Note: You may be wondering why this exists when `ConfigState` exists as well. The API for requesting updates does not mandate that a client cache config files. This implementation just happens to do so.

type ConfigASMDD

type ConfigASMDD struct {
	Config   []byte
	Metadata Metadata
}

ConfigASMDD is a deserialized ASM DD configuration file along with its associated remote config metadata

type ConfigCWSCustom

type ConfigCWSCustom struct {
	Config   []byte
	Metadata Metadata
}

ConfigCWSCustom is a deserialized CWS Custom configuration file along with its associated remote config metadata

type ConfigCWSDD

type ConfigCWSDD struct {
	Config   []byte
	Metadata Metadata
}

ConfigCWSDD is a deserialized CWS DD configuration file along with its associated remote config metadata

type ConfigState

type ConfigState struct {
	Product     string
	ID          string
	Version     uint64
	ApplyStatus ApplyStatus
}

ConfigState describes an applied config by the agent client.

type Metadata

type Metadata struct {
	Product     string
	ID          string
	Name        string
	Version     uint64
	RawLength   uint64
	Hashes      map[string][]byte
	ApplyStatus ApplyStatus
}

Metadata stores remote config metadata for a given configuration

type Repository

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

Repository is a remote config client used in a downstream process to retrieve remote config updates from an Agent.

func NewRepository

func NewRepository(embeddedRoot []byte) (*Repository, error)

NewRepository creates a new remote config repository that will track both TUF metadata and raw config files for a client.

func NewUnverifiedRepository

func NewUnverifiedRepository() (*Repository, error)

NewUnverifiedRepository creates a new remote config repository that will track config files for a client WITHOUT verifying any TUF related metadata.

func (*Repository) APMConfigs

func (r *Repository) APMConfigs() map[string]APMSamplingConfig

APMConfigs returns the currently active APM configs

func (*Repository) APMTracingConfigs

func (r *Repository) APMTracingConfigs() map[string]APMTracingConfig

APMTracingConfigs returns the currently active APMTracing configs

func (*Repository) ASMDDConfigs

func (r *Repository) ASMDDConfigs() map[string]ConfigASMDD

ASMDDConfigs returns the currently active ASMDD configs

func (*Repository) ASMDataConfigs

func (r *Repository) ASMDataConfigs() map[string]ASMDataConfig

ASMDataConfigs returns the currently active ASMData configs

func (*Repository) ASMFeaturesConfigs

func (r *Repository) ASMFeaturesConfigs() map[string]ASMFeaturesConfig

ASMFeaturesConfigs returns the currently active ASMFeatures configs

func (*Repository) CWSCustomConfigs

func (r *Repository) CWSCustomConfigs() map[string]ConfigCWSCustom

CWSCustomConfigs returns the currently active CWSCustom config files

func (*Repository) CWSDDConfigs

func (r *Repository) CWSDDConfigs() map[string]ConfigCWSDD

CWSDDConfigs returns the currently active CWSDD config files

func (*Repository) CurrentState

func (r *Repository) CurrentState() (RepositoryState, error)

CurrentState returns all of the information needed to make an update for new configurations.

func (*Repository) Update

func (r *Repository) Update(update Update) ([]string, error)

Update processes the ClientGetConfigsResponse from the Agent and updates the configuration state

func (*Repository) UpdateApplyStatus

func (r *Repository) UpdateApplyStatus(cfgPath string, status ApplyStatus)

UpdateApplyStatus updates the config's metadata to reflect its processing state Can be used after a call to Update() in order to tell the repository which config was acked, which wasn't and which errors occurred while processing. Note: it is the responsibility of the caller to ensure that no new Update() call was made between the first Update() call and the call to UpdateApplyStatus() so as to keep the repository state accurate.

type RepositoryState

type RepositoryState struct {
	Configs            []ConfigState
	CachedFiles        []CachedFile
	TargetsVersion     int64
	RootsVersion       int64
	OpaqueBackendState []byte
}

RepositoryState contains all of the information about the current config files stored by the client to be able to make an update request to an Agent

type Update

type Update struct {
	// TUFRoots contains, in order, updated roots that this repository needs to keep up with TUF validation
	TUFRoots [][]byte
	// TUFTargets is the latest TUF Targets file and is used to validate raw config files
	TUFTargets []byte
	// TargetFiles stores the raw config files by their full TUF path
	TargetFiles map[string][]byte
	// ClientcConfigs is a list of TUF path's corresponding to config files designated for this repository
	ClientConfigs []string
}

An Update contains all the data needed to update a client's remote config repository state