Documentation
¶
Overview ¶
Package config defines the generalized SCION configuration model.
A Config is the generalized configuration for a single host — the equivalent of one appliance in the Anapaya configuration model. It describes only the elements that host runs, never the rest of the AS. Because it is purely local and self-contained, a service process can render its own config into service-specific files (see the prism package). The model is format-agnostic: it serializes identically to YAML and JSON (see encode.go).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AS ¶
type AS struct {
ISDAS addr.IA `json:"isd_as" yaml:"isd_as"`
Core bool `json:"core" yaml:"core"`
MTU int `json:"mtu" yaml:"mtu"`
Router *Router `json:"router,omitempty" yaml:"router,omitempty"`
Control *Control `json:"control,omitempty" yaml:"control,omitempty"`
Daemon *Daemon `json:"daemon,omitempty" yaml:"daemon,omitempty"`
Neighbors []Neighbor `json:"neighbors,omitempty" yaml:"neighbors,omitempty"`
}
AS describes one AS's local elements. The optional Router/Control/Daemon fields are set exactly for the elements running on this host; their presence is the host's role.
type Config ¶
type Config struct {
SCION SCION `json:"scion" yaml:"scion"`
Interfaces Interfaces `json:"interfaces" yaml:"interfaces"`
}
Config is the generalized configuration for one host.
func (Config) EncodeJSON ¶
EncodeJSON renders the config as indented JSON.
func (Config) EncodeYAML ¶
EncodeYAML renders the config as YAML.
type Control ¶
type Control struct {
ID string `json:"id" yaml:"id"`
Address netip.AddrPort `json:"address" yaml:"address"`
APIAddr netip.AddrPort `json:"api_addr" yaml:"api_addr"`
// Issuing indicates the control service runs the CA (issues certificates).
Issuing bool `json:"issuing" yaml:"issuing"`
}
Control is the control service element on this host.
type Daemon ¶
type Daemon struct {
ID string `json:"id" yaml:"id"`
Address netip.AddrPort `json:"address" yaml:"address"`
APIAddr netip.AddrPort `json:"api_addr" yaml:"api_addr"`
}
Daemon is the SCION daemon (sciond) element on this host.
type Ethernet ¶
type Ethernet struct {
Name string `json:"name" yaml:"name"`
Addresses []string `json:"addresses" yaml:"addresses"`
MTU int `json:"mtu,omitempty" yaml:"mtu,omitempty"`
}
Ethernet is a physical/virtual network interface with CIDR addresses.
type Interface ¶
type Interface struct {
ID uint64 `json:"interface_id" yaml:"interface_id"`
Underlay string `json:"underlay" yaml:"underlay"`
Address netip.AddrPort `json:"address" yaml:"address"`
Remote Remote `json:"remote" yaml:"remote"`
MTU int `json:"scion_mtu" yaml:"scion_mtu"`
}
Interface is one external SCION interface.
type Interfaces ¶
type Interfaces struct {
Ethernets []Ethernet `json:"ethernets,omitempty" yaml:"ethernets,omitempty"`
Loopbacks []Loopback `json:"loopbacks,omitempty" yaml:"loopbacks,omitempty"`
}
Interfaces is the host network-interface section. It captures the underlay binding the SCION addresses sit on, mirroring the Anapaya interfaces model.
type LinkType ¶
type LinkType string
LinkType is the relationship of a neighbor relative to this AS.
type Loopback ¶
type Loopback struct {
Name string `json:"name" yaml:"name"`
Addresses []string `json:"addresses" yaml:"addresses"`
}
Loopback is a logical loopback interface.
type Neighbor ¶
type Neighbor struct {
ISDAS addr.IA `json:"neighbor_isd_as" yaml:"neighbor_isd_as"`
Relationship LinkType `json:"relationship" yaml:"relationship"`
Interfaces []Interface `json:"interfaces" yaml:"interfaces"`
}
Neighbor is a neighboring AS reachable over one or more interfaces on this host's border router.
type Remote ¶
type Remote struct {
Address netip.AddrPort `json:"address" yaml:"address"`
ID uint64 `json:"interface_id" yaml:"interface_id"`
}
Remote is the far side of an external interface.
type Router ¶
type Router struct {
ID string `json:"id" yaml:"id"`
InternalInterface netip.AddrPort `json:"internal_interface" yaml:"internal_interface"`
APIAddr netip.AddrPort `json:"api_addr" yaml:"api_addr"`
SCIONMTU int `json:"scion_mtu" yaml:"scion_mtu"`
}
Router is the data-plane (border router) element on this host.
Source Files