ctrl

Documentation

Overview

Package ctrl handles SCION control-plane payloads, which are encoded as capnp proto messages. Each ctrl payload has a 4B length field prefixed to the start of the capnp message.

Index

• Constants
• type Data
• type Pld
  • func NewCertMgmtPld(u proto.Cerealizable, certD *cert_mgmt.Data, ctrlD *Data) (*Pld, error)
  • func NewPathMgmtPld(u proto.Cerealizable, pathD *path_mgmt.Data, ctrlD *Data) (*Pld, error)
  • func NewPld(u proto.Cerealizable, d *Data) (*Pld, error)
  • func NewPldFromRaw(b common.RawBytes) (*Pld, error)
  • func (p *Pld) Copy() (*Pld, error)
  • func (p *Pld) GetCertMgmt() (*cert_mgmt.Pld, *Data, error)
  • func (p *Pld) GetPathMgmt() (*path_mgmt.Pld, *Data, error)
  • func (p *Pld) Len() int
  • func (p *Pld) ProtoId() proto.ProtoIdType
  • func (p *Pld) SignedPld(signer Signer) (*SignedPld, error)
  • func (p *Pld) String() string
  • func (p *Pld) Union() (proto.Cerealizable, error)
  • func (p *Pld) Write(b common.RawBytes) (int, error)
• type SignSrcDef
  • func NewSignSrcDefFromRaw(b common.RawBytes) (SignSrcDef, error)
  • func (s *SignSrcDef) Equal(t SignSrcDef) bool
  • func (s *SignSrcDef) IsUninitialized() bool
  • func (s *SignSrcDef) Pack() common.RawBytes
  • func (s *SignSrcDef) String() string
• type SignedPld
  • func NewSignedPld(cpld *Pld, signer Signer) (*SignedPld, error)
  • func NewSignedPldFromRaw(b common.RawBytes) (*SignedPld, error)
  • func (sp *SignedPld) Copy() (common.Payload, error)
  • func (sp *SignedPld) GetVerifiedPld(ctx context.Context, verifier Verifier) (*Pld, error)
  • func (sp *SignedPld) Len() int
  • func (sp *SignedPld) PackPld() (common.RawBytes, error)
  • func (sp *SignedPld) ProtoId() proto.ProtoIdType
  • func (sp *SignedPld) String() string
  • func (sp *SignedPld) UnsafePld() (*Pld, error)
  • func (sp *SignedPld) WritePld(b common.RawBytes) (int, error)
• type Signer
• type Verifier

Constants

const (
	// SrcDefaultPrefix is the default prefix for proto.SignS.Src.
	SrcDefaultPrefix = "DEFAULT: "
	// SrcDefaultFmt is the default format for proto.SignS.Src.
	SrcDefaultFmt = `^` + SrcDefaultPrefix + `IA: (\S+) CHAIN: (\d+) TRC: (\d+)$`
)

const LenSize = 4

Types

type Data

type Data struct {
	ReqId   uint64
	TraceId common.RawBytes
}

Data holds all non-union entries from CtrlPld

type Pld

type Pld struct {
	*Data
	// contains filtered or unexported fields
}

func NewCertMgmtPld

func NewCertMgmtPld(u proto.Cerealizable, certD *cert_mgmt.Data, ctrlD *Data) (*Pld, error)

NewCertMgmtPld creates a new control payload, containing a new cert_mgmt payload, which in turn contains the supplied Cerealizable instance.

func NewPathMgmtPld

func NewPathMgmtPld(u proto.Cerealizable, pathD *path_mgmt.Data, ctrlD *Data) (*Pld, error)

NewPathMgmtPld creates a new control payload, containing a new path_mgmt payload, which in turn contains the supplied Cerealizable instance.

func NewPld

func NewPld(u proto.Cerealizable, d *Data) (*Pld, error)

NewPld creates a new control payload, containing the supplied Cerealizable instance.

func NewPldFromRaw

func NewPldFromRaw(b common.RawBytes) (*Pld, error)

func (*Pld) Copy

func (p *Pld) Copy() (*Pld, error)

func (*Pld) GetCertMgmt

func (p *Pld) GetCertMgmt() (*cert_mgmt.Pld, *Data, error)

GetCertMgmt returns the CertMgmt payload and the CtrlPld's non-union Data. If the union type is not CertMgmt, an error is returned.

func (*Pld) GetPathMgmt

func (p *Pld) GetPathMgmt() (*path_mgmt.Pld, *Data, error)

GetPathMgmt returns the PathMgmt payload and the CtrlPld's non-union Data. If the union type is not PathMgmt, an error is returned.

func (*Pld) Len

func (p *Pld) Len() int

func (*Pld) ProtoId

func (p *Pld) ProtoId() proto.ProtoIdType

func (*Pld) SignedPld

func (p *Pld) SignedPld(signer Signer) (*SignedPld, error)

func (*Pld) String

func (p *Pld) String() string

func (*Pld) Union

func (p *Pld) Union() (proto.Cerealizable, error)

func (*Pld) Write

func (p *Pld) Write(b common.RawBytes) (int, error)

type SignSrcDef

type SignSrcDef struct {
	IA       addr.IA
	ChainVer scrypto.Version
	TRCVer   scrypto.Version
}

SignSrcDef is the default format for signature source. It states the signing entity, and the certificate chain authenticating the public key. The TRC version is a hint for the TRC that can currently be used to verify the chain.

func NewSignSrcDefFromRaw

func NewSignSrcDefFromRaw(b common.RawBytes) (SignSrcDef, error)

func (*SignSrcDef) Equal

func (s *SignSrcDef) Equal(t SignSrcDef) bool

func (*SignSrcDef) IsUninitialized

func (s *SignSrcDef) IsUninitialized() bool

IsUninitialized indicates whether the source is equal to the zero value.

func (*SignSrcDef) Pack

func (s *SignSrcDef) Pack() common.RawBytes

func (*SignSrcDef) String

func (s *SignSrcDef) String() string

type SignedPld

type SignedPld struct {
	Blob common.RawBytes
	Sign *proto.SignS
	// contains filtered or unexported fields
}

func NewSignedPld

func NewSignedPld(cpld *Pld, signer Signer) (*SignedPld, error)

func NewSignedPldFromRaw

func NewSignedPldFromRaw(b common.RawBytes) (*SignedPld, error)

func (*SignedPld) Copy

func (sp *SignedPld) Copy() (common.Payload, error)

func (*SignedPld) GetVerifiedPld

func (sp *SignedPld) GetVerifiedPld(ctx context.Context, verifier Verifier) (*Pld, error)

GetVerifiedPld extracts the control payload and verifies it. If verification fails, an error is returned instead.

func (*SignedPld) Len

func (sp *SignedPld) Len() int

func (*SignedPld) PackPld

func (sp *SignedPld) PackPld() (common.RawBytes, error)

func (*SignedPld) ProtoId

func (sp *SignedPld) ProtoId() proto.ProtoIdType

func (*SignedPld) String

func (sp *SignedPld) String() string

func (*SignedPld) UnsafePld

func (sp *SignedPld) UnsafePld() (*Pld, error)

UnsafePld extracts the control payload without verifying the payload.

func (*SignedPld) WritePld

func (sp *SignedPld) WritePld(b common.RawBytes) (int, error)

type Signer

type Signer interface {
	Sign(msg []byte) (*proto.SignS, error)
}

Signer takes a message and signs it, producing the signature metadata.

type Verifier

type Verifier interface {
	VerifyPld(context.Context, *SignedPld) (*Pld, error)
}

Verifier verifies the signature of a signed payload.