infra

Documentation

Overview

Package infra contains common definitions for the SCION infrastructure messaging layer.

Index

• Constants
• func NewContextWithMessenger(ctx context.Context, msger Messenger) context.Context
• func NewCtxDoneError(ctx ...interface{}) error
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) Handle(r *Request)
• type MessageType
  • func (mt MessageType) String() string
• type Messenger
  • func MessengerFromContext(ctx context.Context) (Messenger, bool)
• type Request
  • func NewRequest(ctx context.Context, msg, fullMsg proto.Cerealizable, peer net.Addr, id uint64, ...) *Request
  • func (r *Request) Context() context.Context
• type Transport
• type TrustStore

Constants

const (
	StrCtxDoneError   = "context canceled"
	StrClosedError    = "layer closed"
	StrAdapterError   = "msg adapter error"
	StrInternalError  = "internal error"
	StrTransportError = "transport error"
)

Functions

func NewContextWithMessenger

func NewContextWithMessenger(ctx context.Context, msger Messenger) context.Context

func NewCtxDoneError

func NewCtxDoneError(ctx ...interface{}) error

Types

type Handler

type Handler interface {
	Handle(*Request)
}

Interface Handler is implemented by objects that can handle a request coming from a remote SCION network node.

type HandlerFunc

type HandlerFunc func(r *Request)

Constructs a handler for request r. Handle() can be called on the resulting object to process the message.

func (HandlerFunc) Handle

func (f HandlerFunc) Handle(r *Request)

type MessageType

type MessageType int

const (
	None MessageType = iota
	TRC
	TRCRequest
	Chain
	ChainRequest
	PathSegmentRequest
	PathSegmentReply
	ChainIssueRequest
	ChainIssueReply
)

func (MessageType) String

func (mt MessageType) String() string

type Messenger

type Messenger interface {
	GetTRC(ctx context.Context, msg *cert_mgmt.TRCReq, a net.Addr,
		id uint64) (*cert_mgmt.TRC, error)
	SendTRC(ctx context.Context, msg *cert_mgmt.TRC, a net.Addr, id uint64) error
	GetCertChain(ctx context.Context, msg *cert_mgmt.ChainReq, a net.Addr,
		id uint64) (*cert_mgmt.Chain, error)
	SendCertChain(ctx context.Context, msg *cert_mgmt.Chain, a net.Addr, id uint64) error
	GetPathSegs(ctx context.Context, msg *path_mgmt.SegReq, a net.Addr,
		id uint64) (*path_mgmt.SegReply, error)
	RequestChainIssue(ctx context.Context, msg *cert_mgmt.ChainIssReq, a net.Addr,
		id uint64) (*cert_mgmt.ChainIssRep, error)
	SendChainIssueReply(ctx context.Context, msg *cert_mgmt.ChainIssRep, a net.Addr,
		id uint64) error
	AddHandler(msgType MessageType, h Handler)
	ListenAndServe()
	CloseServer() error
}

func MessengerFromContext

func MessengerFromContext(ctx context.Context) (Messenger, bool)

type Request

type Request struct {
	// Message is the inner proto.Cerealizable message, as supported by
	// messenger.Messenger (e.g., a *cert_mgmt.ChainReq). For information about
	// possible messages, see the package documentation for that package.
	Message proto.Cerealizable
	// FullMessage is the top-level SignedCtrlPld message read from the wire
	FullMessage proto.Cerealizable
	// Peer is the node that sent this request
	Peer net.Addr
	// ID is the CtrlPld top-level ID.
	ID uint64
	// Logger can be used to write handler-scope messages in a way that can be
	// easily correlated with server request/responses.
	Logger log.Logger
	// contains filtered or unexported fields
}

Request describes an object received from the network that is not part of an exchange initiated by the local node. A Request includes its associated context.

func NewRequest

func NewRequest(ctx context.Context, msg, fullMsg proto.Cerealizable, peer net.Addr,
	id uint64, logger log.Logger) *Request

func (*Request) Context

func (r *Request) Context() context.Context

Context returns the request's context.

type Transport

type Transport interface {
	// Send an unreliable message. Unreliable transport layers do not request
	// an ACK. For reliable transport layers, this is the same as SendMsgTo.
	SendUnreliableMsgTo(context.Context, common.RawBytes, net.Addr) error
	// Send a reliable message. Unreliable transport layers block here waiting
	// for the message to be ACK'd. Reliable transport layers return
	// immediately.
	SendMsgTo(context.Context, common.RawBytes, net.Addr) error
	// Receive a message.
	RecvFrom(context.Context) (common.RawBytes, net.Addr, error)
	// Clean up.
	Close(context.Context) error
}

Interface Transport wraps around low-level networking objects to provide reliable and unreliable delivery of network packets, together with context-aware networking that can be used to construct handlers with timeouts.

Transport layers must be safe for concurrent use by multiple goroutines.

type TrustStore

type TrustStore interface {
	GetValidChain(ctx context.Context, ia addr.IA, source net.Addr) (*cert.Chain, error)
	GetValidTRC(ctx context.Context, isd addr.ISD, source net.Addr) (*trc.TRC, error)
	GetValidCachedTRC(ctx context.Context, isd addr.ISD) (*trc.TRC, error)
	GetChain(ctx context.Context, ia addr.IA, version uint64) (*cert.Chain, error)
	GetTRC(ctx context.Context, isd addr.ISD, version uint64) (*trc.TRC, error)
	NewTRCReqHandler(recurseAllowed bool) Handler
	NewChainReqHandler(recurseAllowed bool) Handler
	SetMessenger(msger Messenger)
}