packet

Documentation

Overview

Package packet implements the Katzenpost server side packet structure.

Index

• func ParseForwardPacket(pkt *Packet) ([]byte, []byte, error)
• type Packet
  • func New(raw []byte) (*Packet, error)
  • func NewPacketFromSURB(pkt *Packet, surb, payload []byte) (*Packet, error)
  • func NewWithID(raw []byte, id uint64) (*Packet, error)
  • func (pkt *Packet) CmdsToString() string
  • func (pkt *Packet) Dispose()
  • func (pkt *Packet) IsForward() bool
  • func (pkt *Packet) IsSURBReply() bool
  • func (pkt *Packet) IsToUser() bool
  • func (pkt *Packet) IsUnreliableToUser() bool
  • func (pkt *Packet) Set(payload []byte, cmds []commands.RoutingCommand) error

Functions

func ParseForwardPacket

func ParseForwardPacket(pkt *Packet) ([]byte, []byte, error)

Types

type Packet

type Packet struct {
	Raw     []byte
	Payload []byte

	// The parsed out routing commands.
	NextNodeHop *commands.NextNodeHop
	NodeDelay   *commands.NodeDelay
	Recipient   *commands.Recipient
	SurbReply   *commands.SURBReply

	ID         uint64
	Delay      time.Duration
	RecvAt     time.Duration
	DispatchAt time.Duration

	MustForward   bool
	MustTerminate bool
}

func New

func New(raw []byte) (*Packet, error)

New allocates a new Packet, with the specified raw payload.

func NewPacketFromSURB

func NewPacketFromSURB(pkt *Packet, surb, payload []byte) (*Packet, error)

func NewWithID

func NewWithID(raw []byte, id uint64) (*Packet, error)

NewWithID allocates a new Packet, with the specified raw payload and ID. Most callers should use New, this exists to support serializing packets to external memory.

func (*Packet) CmdsToString

func (pkt *Packet) CmdsToString() string

CmdsToString returns an abbreviated list of the packet's routing commands, suitable for debugging.

func (*Packet) Dispose

func (pkt *Packet) Dispose()

Dispose clears the packet structure and returns it to the allocation pool.

func (*Packet) IsForward

func (pkt *Packet) IsForward() bool

IsForward returns true iff the packet has routing commands indicating it is a forward packet destined for another hop.

func (*Packet) IsSURBReply

func (pkt *Packet) IsSURBReply() bool

IsSURBReply returns true iff the packet has routing commands indicating it is a SURB Reply destined for a local user.

func (*Packet) IsToUser

func (pkt *Packet) IsToUser() bool

IsToUser returns true iff the packet has routing commands indicating it is a forward packet destined for a local user.

func (*Packet) IsUnreliableToUser

func (pkt *Packet) IsUnreliableToUser() bool

IsUnreliableToUser returns true iff the packet has routing commands indicating it is an unreliable forward packet destined for a local user.

func (*Packet) Set

func (pkt *Packet) Set(payload []byte, cmds []commands.RoutingCommand) error

Set sets the Packet's internal components.