infraenv

Documentation

Overview

Package infraenv contains convenience function common to SCION infra services.

Index

• Constants
• func GenerateTLSConfig() (*tls.Config, error)
• func InitInfraEnvironment(topologyPath string)
• func InitInfraEnvironmentFunc(topologyPath string, f func())
• func NewRouter(localIA addr.IA, sd env.SCIONDClient) (snet.Router, error)
• type NetworkConfig
  • func (nc *NetworkConfig) AddressRewriter(connFactory snet.PacketDispatcherService) *messenger.AddressRewriter
  • func (nc *NetworkConfig) QUICStack() (*QUICStack, error)
  • func (nc *NetworkConfig) TCPStack() (net.Listener, error)
• type QUIC
• type QUICStack

Constants

const (
	ErrAppUnableToInitMessenger common.ErrMsg = "Unable to initialize SCION Infra Messenger"
)

Functions

func GenerateTLSConfig

func GenerateTLSConfig() (*tls.Config, error)

GenerateTLSConfig generates a self-signed certificate.

func InitInfraEnvironment

func InitInfraEnvironment(topologyPath string)

func InitInfraEnvironmentFunc

func InitInfraEnvironmentFunc(topologyPath string, f func())

InitInfraEnvironmentFunc sets up the environment by first calling env.RealoadTopology and then the provided function.

func NewRouter

func NewRouter(localIA addr.IA, sd env.SCIONDClient) (snet.Router, error)

NewRouter constructs a path router for paths starting from localIA.

Types

type NetworkConfig

type NetworkConfig struct {
	// IA is the local AS number.
	IA addr.IA
	// Public is the Internet-reachable address in the case where the service
	// is behind NAT.
	Public *net.UDPAddr
	// ReconnectToDispatcher sets up sockets that automatically reconnect if
	// the dispatcher closes the connection (e.g., if the dispatcher goes
	// down).
	ReconnectToDispatcher bool
	// QUIC contains configuration details for QUIC servers. If the listening
	// address is the empty string, then no QUIC socket is opened.
	QUIC QUIC
	// SVCRouter is used to discover the underlay addresses of intra-AS SVC
	// servers.
	SVCRouter messenger.LocalSVCRouter
	// SCMPHandler is the SCMP handler to use. This handler is only applied to
	// client connections. The connection the server listens on will always
	// ignore SCMP messages. Otherwise, the server will shutdown when receiving
	// an SCMP error message.
	SCMPHandler snet.SCMPHandler
}

NetworkConfig describes the networking configuration of a SCION control-plane RPC endpoint.

func (*NetworkConfig) AddressRewriter

func (nc *NetworkConfig) AddressRewriter(
	connFactory snet.PacketDispatcherService) *messenger.AddressRewriter

AddressRewriter initializes path and svc resolvers for infra servers.

The connection factory is used to open sockets for SVC resolution requests. If the connection factory is nil, the default connection factory is used.

func (*NetworkConfig) QUICStack

func (nc *NetworkConfig) QUICStack() (*QUICStack, error)

func (*NetworkConfig) TCPStack

func (nc *NetworkConfig) TCPStack() (net.Listener, error)

type QUIC

type QUIC struct {
	// Address is the UDP address to start the QUIC server on.
	Address string
}

QUIC contains the QUIC configuration for control-plane speakers.

type QUICStack

type QUICStack struct {
	Listener       *squic.ConnListener
	Dialer         *squic.ConnDialer
	RedirectCloser func()
}

QUICStack contains everything to run a QUIC based RPC stack.