infra

Documentation

Index

• Constants
• Variables
• func NewContextWithResponseWriter(ctx context.Context, rw ResponseWriter) context.Context
• type Error
  • func (e *Error) Error() string
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) Handle(r *Request) *HandlerResult
• type HandlerResult
  • func MetricsErrMsger(err error) *HandlerResult
  • func MetricsErrRevCache(err error) *HandlerResult
  • func MetricsErrTrustDB(err error) *HandlerResult
  • func MetricsErrTrustStore(err error) *HandlerResult
  • func MetricsErrWithTimeout(err error, timeoutResult, result *HandlerResult) *HandlerResult
• type MessageType
  • func (mt MessageType) MetricLabel() string
  • func (mt MessageType) String() string
• type Request
  • func NewRequest(ctx context.Context, msg, fullMsg proto.Cerealizable, peer net.Addr, id uint64) *Request
  • func (r *Request) Context() context.Context
• type ResponseWriter
  • func ResponseWriterFromContext(ctx context.Context) (ResponseWriter, bool)
• type Verifier

Constants

const (
	PromSrcASLocal   = "as_local"
	PromSrcISDLocal  = "isd_local"
	PromSrcISDRemote = "isd_remote"
	PromSrcUnknown   = "unknown"
)

const (
	// DefaultRPCTimeout is the default silent time SCION RPC Clients will wait
	// for before declaring a timeout. Most RPCs will be subject to an
	// additional context, and the timeout will be the minimum value allowed by
	// the context and this timeout. RPC clients are free to use a different
	// timeout if they have special requirements.
	DefaultRPCTimeout time.Duration = 10 * time.Second
)

Variables

var (
	MetricsErrInternal = &HandlerResult{Result: "err_internal", Status: prom.StatusErr}
	MetricsErrInvalid  = &HandlerResult{Result: "err_invalid_req", Status: prom.StatusErr}

	MetricsResultOk = &HandlerResult{Result: prom.Success, Status: prom.StatusOk}
)

Functions

func NewContextWithResponseWriter

func NewContextWithResponseWriter(ctx context.Context, rw ResponseWriter) context.Context

Types

type Error

type Error struct {
	Message *ack.Ack
}

func (*Error) Error

func (e *Error) Error() string

type Handler

type Handler interface {
	Handle(*Request) *HandlerResult
}

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

type HandlerFunc

type HandlerFunc func(r *Request) *HandlerResult

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) *HandlerResult

type HandlerResult

type HandlerResult struct {
	// Result is the label used for the result metric.
	Result string
	// Status is one of prom.StatusOk, prom.StatusErr, prom.StatusTimeout it is used for the latency
	// histogram. This is a reduced view of the result, so that we don't get too many timeseries on
	// the histogram.
	Status string
}

HandlerResult contains a result label and a status label.

func MetricsErrMsger

func MetricsErrMsger(err error) *HandlerResult

func MetricsErrRevCache

func MetricsErrRevCache(err error) *HandlerResult

func MetricsErrTrustDB

func MetricsErrTrustDB(err error) *HandlerResult

func MetricsErrTrustStore

func MetricsErrTrustStore(err error) *HandlerResult

func MetricsErrWithTimeout

func MetricsErrWithTimeout(err error, timeoutResult, result *HandlerResult) *HandlerResult

MetricsErrWithTimeout checks if the error is a timeout and if so returns timeoutResult otherwise returns result.

type MessageType

type MessageType int

const (
	None MessageType = iota
	IfId
	Ack
	HPSegReg
	HPSegRequest
	HPSegReply
	HPCfgRequest
	HPCfgReply
)

func (MessageType) MetricLabel

func (mt MessageType) MetricLabel() string

MetricLabel returns the label for metrics for a given message type. The postfix for requests is always "req" and for replies and push messages it is always "push".

func (MessageType) String

func (mt MessageType) String() string

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
	// 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) *Request

func (*Request) Context

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

Context returns the request's context.

type ResponseWriter

type ResponseWriter interface {
	SendAckReply(ctx context.Context, msg *ack.Ack) error
	SendHPSegReply(ctx context.Context, msg *path_mgmt.HPSegReply) error
	SendHPCfgReply(ctx context.Context, msg *path_mgmt.HPCfgReply) error
}

func ResponseWriterFromContext

func ResponseWriterFromContext(ctx context.Context) (ResponseWriter, bool)

type Verifier

type Verifier interface {
	seg.Verifier
	// WithServer returns a verifier that fetches the necessary crypto
	// objects from the specified server.
	WithServer(server net.Addr) Verifier
	// WithIA returns a verifier that only accepts signatures from the
	// specified IA.
	WithIA(ia addr.IA) Verifier
}

Verifier is used to verify payloads signed with control-plane PKI certificates.