config

Documentation

Overview

Package config describes the configuration of the beacon server.

Index

• Constants
• type BSConfig
  • func (cfg *BSConfig) ConfigName() string
  • func (cfg *BSConfig) InitDefaults()
  • func (cfg *BSConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *BSConfig) Validate() error
• type CA
  • func (cfg *CA) ConfigName() string
  • func (cfg *CA) InitDefaults()
  • func (cfg *CA) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *CA) Validate() error
• type CAMode
• type CAService
  • func (cfg *CAService) ConfigName() string
  • func (cfg *CAService) InitDefault()
  • func (cfg *CAService) Sample(dst io.Writer, _ config.Path, _ config.CtxMap)
• type Config
  • func (cfg *Config) InitDefaults()
  • func (cfg *Config) Sample(dst io.Writer, path config.Path, _ config.CtxMap)
  • func (cfg *Config) Validate() error
• type DRKeyConfig
  • func (cfg *DRKeyConfig) ConfigName() string
  • func (cfg *DRKeyConfig) Enabled() bool
  • func (cfg *DRKeyConfig) InitDefaults()
  • func (cfg *DRKeyConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *DRKeyConfig) Validate() error
• type HostProto
• type PSConfig
  • func (cfg *PSConfig) ConfigName() string
  • func (cfg *PSConfig) InitDefaults()
  • func (cfg *PSConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *PSConfig) Validate() error
• type Policies
  • func (cfg *Policies) ConfigName() string
  • func (cfg *Policies) Sample(dst io.Writer, _ config.Path, _ config.CtxMap)
• type SecretValueHostList
  • func (cfg *SecretValueHostList) ConfigName() string
  • func (cfg *SecretValueHostList) InitDefaults()
  • func (cfg *SecretValueHostList) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)
  • func (cfg *SecretValueHostList) ToAllowedSet() map[HostProto]struct{}
  • func (cfg *SecretValueHostList) Validate() error

Constants

const (
	// DefaultOriginationInterval is the default interval between originating
	// beacons in a core BS.
	DefaultOriginationInterval = 5 * time.Second
	// DefaultPropagationInterval is the default interval between propagating beacons.
	DefaultPropagationInterval = 5 * time.Second
	// DefaultRegistrationInterval is the default interval between registering segments.
	DefaultRegistrationInterval = 5 * time.Second
	// DefaultQueryInterval is the default interval after which the segment
	// cache expires.
	DefaultQueryInterval = 5 * time.Minute
	// DefaultMaxASValidity is the default validity period for renewed AS certificates.
	DefaultMaxASValidity = 3 * 24 * time.Hour
)

const DefaultPrefetchEntries = 10000

Types

type BSConfig

type BSConfig struct {
	// OriginationInterval is the interval between originating beacons in a core BS.
	OriginationInterval util.DurWrap `toml:"origination_interval,omitempty"`
	// PropagationInterval is the interval between propagating beacons.
	PropagationInterval util.DurWrap `toml:"propagation_interval,omitempty"`
	// RegistrationInterval is the interval between registering segments.
	RegistrationInterval util.DurWrap `toml:"registration_interval,omitempty"`
	// Policies contains the policy files.
	Policies Policies `toml:"policies,omitempty"`
	// EPIC specifies whether the EPIC authenticators should be added to the beacons.
	EPIC bool `toml:"epic,omitempty" default:"false"`
}

BSConfig holds the configuration specific to the beacon server.

func (*BSConfig) ConfigName

func (cfg *BSConfig) ConfigName() string

ConfigName is the toml key for the beacon server specific configuration.

func (*BSConfig) InitDefaults

func (cfg *BSConfig) InitDefaults()

InitDefaults the default values for the durations that are equal to zero.

func (*BSConfig) Sample

func (cfg *BSConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

Sample generates a sample for the beacon server specific configuration.

func (*BSConfig) Validate

func (cfg *BSConfig) Validate() error

Validate validates that all durations are set.

type CA

type CA struct {
	// MaxASValidity is the maximum AS certificate lifetime.
	MaxASValidity util.DurWrap `toml:"max_as_validity,omitempty"`
	// Mode defines whether the Control Service should handle certificate
	// issuance requests on its own, or whether to delegate handling to a
	// dedicated Certificate Authority. If it is the empty string, the
	// in-process mode is selected as the default.
	Mode CAMode `toml:"mode,omitempty"`
	// Service contains details about CA functionality delegation.
	Service CAService `toml:"service,omitempty"`
}

CA is the CA configuration.

func (*CA) ConfigName

func (cfg *CA) ConfigName() string

func (*CA) InitDefaults

func (cfg *CA) InitDefaults()

func (*CA) Sample

func (cfg *CA) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

func (*CA) Validate

func (cfg *CA) Validate() error

type CAMode

type CAMode string

const (
	Disabled   CAMode = "disabled"
	Delegating CAMode = "delegating"
	InProcess  CAMode = "in-process"
)

type CAService

type CAService struct {
	// SharedSecret is the path to the PEM-encoded shared secret that is used to
	// create JWT tokens.
	SharedSecret string `toml:"shared_secret,omitempty"`
	// Address of the CA Service that handles the delegated certificate renewal requests.
	Address string `toml:"addr,omitempty"`
	// Lifetime contains the validity period of self-generated JWT authorization tokens. The format
	// is a Go duration. If not set, the application default is used instead (see the sample for
	// the value).
	Lifetime util.DurWrap `toml:"lifetime,omitempty"`
	// ClientID is the client identification string that should be used in self-generated JWT
	// authorization tokens. If not set, the SCION ID is used instead.
	ClientID string `toml:"client_id,omitempty"`
}

CAService contains details about CA functionality delegation.

func (*CAService) ConfigName

func (cfg *CAService) ConfigName() string

func (*CAService) InitDefault

func (cfg *CAService) InitDefault()

func (*CAService) Sample

func (cfg *CAService) Sample(dst io.Writer, _ config.Path, _ config.CtxMap)

type Config

type Config struct {
	General     env.General        `toml:"general,omitempty"`
	Features    env.Features       `toml:"features,omitempty"`
	Logging     log.Config         `toml:"log,omitempty"`
	Metrics     env.Metrics        `toml:"metrics,omitempty"`
	API         api.Config         `toml:"api,omitempty"`
	Tracing     env.Tracing        `toml:"tracing,omitempty"`
	QUIC        env.QUIC           `toml:"quic,omitempty"`
	BeaconDB    storage.DBConfig   `toml:"beacon_db,omitempty"`
	TrustDB     storage.DBConfig   `toml:"trust_db,omitempty"`
	PathDB      storage.DBConfig   `toml:"path_db,omitempty"`
	BS          BSConfig           `toml:"beaconing,omitempty"`
	PS          PSConfig           `toml:"path,omitempty"`
	CA          CA                 `toml:"ca,omitempty"`
	TrustEngine trustengine.Config `toml:"trustengine,omitempty"`
	DRKey       DRKeyConfig        `toml:"drkey,omitempty"`
}

Config is the control server configuration.

func (*Config) InitDefaults

func (cfg *Config) InitDefaults()

InitDefaults initializes the default values for all parts of the config.

func (*Config) Sample

func (cfg *Config) Sample(dst io.Writer, path config.Path, _ config.CtxMap)

Sample generates a sample config file for the beacon server.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate validates all parts of the config.

type DRKeyConfig

type DRKeyConfig struct {
	Level1DB        storage.DBConfig    `toml:"level1_db,omitempty"`
	SecretValueDB   storage.DBConfig    `toml:"secret_value_db,omitempty"`
	Delegation      SecretValueHostList `toml:"delegation,omitempty"`
	PrefetchEntries int                 `toml:"prefetch_entries,omitempty"`
}

DRKeyConfig is the configuration for the connection to the trust database.

func (*DRKeyConfig) ConfigName

func (cfg *DRKeyConfig) ConfigName() string

ConfigName is the key in the toml file.

func (*DRKeyConfig) Enabled

func (cfg *DRKeyConfig) Enabled() bool

Enabled returns true if DRKey is configured. False otherwise.

func (*DRKeyConfig) InitDefaults

func (cfg *DRKeyConfig) InitDefaults()

InitDefaults initializes values of unset keys and determines if the configuration enables DRKey.

func (*DRKeyConfig) Sample

func (cfg *DRKeyConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

Sample writes a config sample to the writer.

func (*DRKeyConfig) Validate

func (cfg *DRKeyConfig) Validate() error

Validate validates that all values are parsable.

type HostProto

type HostProto struct {
	Host  netip.Addr
	Proto drkey.Protocol
}

type PSConfig

type PSConfig struct {
	// QueryInterval specifies after how much time segments
	// for a destination should be refetched.
	QueryInterval util.DurWrap `toml:"query_interval,omitempty"`
	// HiddenPathsCfg specifies the file name of the hidden path configuration.
	// If HiddenPathsCfg begins with http:// or https://, it will be fetched
	// over the network from the specified URL instead.
	HiddenPathsCfg string `toml:"hidden_paths_cfg,omitempty"`
}

func (*PSConfig) ConfigName

func (cfg *PSConfig) ConfigName() string

func (*PSConfig) InitDefaults

func (cfg *PSConfig) InitDefaults()

func (*PSConfig) Sample

func (cfg *PSConfig) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

func (*PSConfig) Validate

func (cfg *PSConfig) Validate() error

type Policies

type Policies struct {
	config.NoDefaulter
	config.NoValidator
	// Propagation contains the file path for the propagation policy. If this
	// is the empty string, the default policy is used.
	Propagation string `toml:"propagation,omitempty"`
	// CoreRegistration contains the file path for the core registration
	// policy. If this is the empty string, the default policy is used. In a
	// non-core beacon server, this field is ignored.
	CoreRegistration string `toml:"core_registration,omitempty"`
	// UpRegistration contains the file path for the up registration policy. If
	// this is the empty string, the default policy is used. In a core beacon
	// server, this field is ignored.
	UpRegistration string `toml:"up_registration,omitempty"`
	// DownRegistration contains the file path for the down registration policy.
	// If this is the empty string, the default policy is used. In a core beacon
	// server, this field is ignored.
	DownRegistration string `toml:"down_registration,omitempty"`
}

Policies contains the file paths of the policies.

func (*Policies) ConfigName

func (cfg *Policies) ConfigName() string

ConfigName is the toml key for the beacon server specific configuration.

func (*Policies) Sample

func (cfg *Policies) Sample(dst io.Writer, _ config.Path, _ config.CtxMap)

Sample generates a sample for the beacon server specific configuration.

type SecretValueHostList

type SecretValueHostList map[string][]string

SecretValueHostList configures which endhosts can get delegation secrets, per protocol.

func (*SecretValueHostList) ConfigName

func (cfg *SecretValueHostList) ConfigName() string

ConfigName is the key in the toml file.

func (*SecretValueHostList) InitDefaults

func (cfg *SecretValueHostList) InitDefaults()

InitDefaults will not add or modify any entry in the config.

func (*SecretValueHostList) Sample

func (cfg *SecretValueHostList) Sample(dst io.Writer, path config.Path, ctx config.CtxMap)

Sample writes a config sample to the writer.

func (*SecretValueHostList) ToAllowedSet

func (cfg *SecretValueHostList) ToAllowedSet() map[HostProto]struct{}

ToAllowedSet will return map where there is a set of supported (Host,Protocol).

func (*SecretValueHostList) Validate

func (cfg *SecretValueHostList) Validate() error

Validate validates that the protocols exist, and their addresses are parsable.