Documentation
¶
Overview ¶
Package env contains common command line and initialization code for SCION services. If something is specific to one app, it should go into that app's code and not here.
During initialization, SIGHUPs are masked. To call a function on each SIGHUP, pass the function when calling Init.
Index ¶
Constants ¶
const ( // TopologyFile is the file name for the topology file. TopologyFile = "topology.json" // StaticInfoConfigFile is the file name for the configuration file // used for the StaticInfo beacon extension. StaticInfoConfigFile = "staticInfoConfig.json" // SciondInitConnectPeriod is the default total amount of time spent // attempting to connect to the daemon on start. SciondInitConnectPeriod = 20 * time.Second // ShutdownGraceInterval is the time applications wait after issuing a // clean shutdown signal, before forcerfully tearing down the application. ShutdownGraceInterval = 5 * time.Second )
Variables ¶
var ( // The value is generated by tools/git-version. StartupVersion string )
Startup* variables are set during link time.
Functions ¶
func LogAppStarted ¶
LogAppStarted should be called by applications as soon as logging is initialized.
func LogAppStopped ¶
func LogAppStopped(svcType, elemID string)
func RunsInDocker ¶ added in v0.9.0
RunsInDocker returns whether the current binary is run in a docker container.
func VersionInfo ¶
func VersionInfo() string
VersionInfo returns build version information (build date, build version, build chain).
Types ¶
type Daemon ¶
type Daemon struct {
// Address of the SCION Daemon the client should connect to. Defaults to
// 127.0.0.1:30255.
Address string `toml:"address,omitempty"`
// InitialConnectPeriod is the maximum amount of time spent attempting to
// connect to the daemon on start.
InitialConnectPeriod util.DurWrap `toml:"initial_connect_period,omitempty"`
// FakeData can be used to replace the local daemon with a fake data source.
// It must point to a fake daemon configuration file.
FakeData string `toml:"fake_data,omitempty"`
}
Daemon contains information for running snet with the SCION Daemon.
func (*Daemon) ConfigName ¶
func (*Daemon) InitDefaults ¶
func (cfg *Daemon) InitDefaults()
type Features ¶
type Features struct {
config.NoDefaulter
config.NoValidator
// AppropriateDigest enables the CA module to sign issued certificates
// with the appropriate digest algorithm instead of always using ECDSAWithSHA512.
//
// Experimental: This field is experimental and will be subject to change.
AppropriateDigest bool `toml:"appropriate_digest_algorithm"`
// ExperimentalSCMPAuthentication enables experimental, DRKey-based
// authentication of SCMP messages.
//
// When enabled, the router inserts the SPAO authenticator for SCMP error messages,
// generated with a dummy key!
//
// Experimental: This field is experimental and will be subject to change.
ExperimentalSCMPAuthentication bool `toml:"experimental_scmp_authentication"`
}
Features contains all feature flags. Add feature flags to this structure as needed. Feature flags are always boolean. Don't use any other types here!
func (*Features) ConfigName ¶
type General ¶
type General struct {
// ID is the SCION element ID. This is used to choose the relevant
// portion of the topology file for some services.
ID string `toml:"id,omitempty"`
// ConfigDir for loading extra files (currently, only topology.json and staticInfoConfig.json)
ConfigDir string `toml:"config_dir,omitempty"`
// ReconnectToDispatcher can be set to true to enable transparent dispatcher
// reconnects.
ReconnectToDispatcher bool `toml:"reconnect_to_dispatcher,omitempty"`
}
func (*General) ConfigName ¶
func (*General) InitDefaults ¶
func (cfg *General) InitDefaults()
InitDefaults sets the default value for Topology if not already set.
func (*General) StaticInfoConfig ¶
StaticInfoConfig return the path to the configuration file for the StaticInfo beacon extension.
type Metrics ¶
type Metrics struct {
config.NoDefaulter
config.NoValidator
// Prometheus contains the address to export prometheus metrics on. If
// not set, metrics are not exported.
Prometheus string `toml:"prometheus,omitempty"`
}
func (*Metrics) ConfigName ¶
type QUIC ¶
type QUIC struct {
Address string `toml:"address,omitempty"`
}
QUIC contains configuration for control-plane speakers.
func (*QUIC) ConfigName ¶
type Tracing ¶
type Tracing struct {
// Enabled enables tracing for this service.
Enabled bool `toml:"enabled,omitempty"`
// Enable debug mode.
Debug bool `toml:"debug,omitempty"`
// Agent is the address of the local agent that handles the reported
// traces. (default: localhost:6831)
Agent string `toml:"agent,omitempty"`
}
Tracing contains configuration for tracing.
func (*Tracing) ConfigName ¶
func (*Tracing) InitDefaults ¶
func (cfg *Tracing) InitDefaults()
Source Files
Directories