env

Documentation

Overview

Package env contains host-wide SCION settings. Contents will most likely be populated by reading a well-known file on the host, e.g., /etc/scion/environment.json.

Index

• type AS
  • func (a *AS) Validate() error
• type General
  • func (g *General) Validate() error
• type SCION
  • func (s *SCION) Validate() error

Types

type AS

type AS struct {
	// DaemonAddress is the address of the SCION Daemon API endpoint.
	DaemonAddress string `json:"daemon_address,omitempty"`
}

func (*AS) Validate

func (a *AS) Validate() error

type General

type General struct {
	// DefaultIA is the ISD-AS that will be used by default as a source AS in case multiple SCION
	// ASes are available on the host.
	DefaultIA addr.IA `json:"default_isd_as,omitempty"`
	// DispatcherSocket is the path to the dispatcher socket.
	DispatcherSocket string `json:"dispatcher_socket,omitempty"`
}

General contains general, AS-independent host-wide SCION settings.

func (*General) Validate

func (g *General) Validate() error

type SCION

type SCION struct {
	// General contains general, AS-independent host-wide SCION settings.
	General General `json:"general,omitempty"`
	// ASes contains AS-specific host-wide SCION settings.
	ASes map[addr.IA]AS `json:"ases,omitempty"`
}

SCION is the top-level object containing the host-wide SCION environment settings.

func (*SCION) Validate

func (s *SCION) Validate() error