Version: v0.6.18 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2021 License: AGPL-3.0 Imports: 6 Imported by: 3




View Source
const (
	IPv4 = IPVersion(4)
	IPv6 = IPVersion(6)

	InBound  = true
	OutBound = false

	ICMP    = IPProtocol(1)
	IGMP    = IPProtocol(2)
	TCP     = IPProtocol(6)
	UDP     = IPProtocol(17)
	ICMPv6  = IPProtocol(58)
	UDPLite = IPProtocol(136)
	RAW     = IPProtocol(255)

Basic Constants


View Source
var (
	// ErrFailedToLoadPayload is returned by GetPayload if it failed for an unspecified reason, or is not implemented on the current system.
	ErrFailedToLoadPayload = errors.New("could not load packet payload")


func Parse added in v0.2.5

func Parse(packetData []byte, pktBase *Base) (err error)

Parse parses an IP packet and saves the information in the given packet object.


type Base added in v0.2.5

type Base struct {
	// contains filtered or unexported fields

Base is a base structure for satisfying the Packet interface.

func (*Base) Ctx added in v0.2.5

func (pkt *Base) Ctx() context.Context

Ctx returns the packet context.

func (*Base) FastTrackedByIntegration added in v0.6.12

func (pkt *Base) FastTrackedByIntegration() bool

FastTrackedByIntegration returns whether the packet has been fast-track accepted by the OS integration.

func (*Base) FmtPacket added in v0.2.5

func (pkt *Base) FmtPacket() string

FmtPacket returns the most important information about the packet as a string

func (*Base) FmtProtocol added in v0.2.5

func (pkt *Base) FmtProtocol() string

FmtProtocol returns the protocol as a string

func (*Base) FmtRemoteAddress added in v0.2.5

func (pkt *Base) FmtRemoteAddress() string

FmtRemoteAddress returns the full remote address (protocol, IP, port) as a string

func (*Base) FmtRemoteIP added in v0.2.5

func (pkt *Base) FmtRemoteIP() string

FmtRemoteIP returns the remote IP address as a string

func (*Base) FmtRemotePort added in v0.2.5

func (pkt *Base) FmtRemotePort() string

FmtRemotePort returns the remote port as a string

func (*Base) GetConnectionID added in v0.4.0

func (pkt *Base) GetConnectionID() string

GetConnectionID returns the link ID for this packet.

func (*Base) HasPorts added in v0.2.5

func (pkt *Base) HasPorts() bool

HasPorts checks if the packet has a protocol that uses ports.

func (*Base) Info added in v0.2.5

func (pkt *Base) Info() *Info

Info returns the packet Info.

func (*Base) IsInbound added in v0.2.5

func (pkt *Base) IsInbound() bool

IsInbound checks if the packet is inbound.

func (*Base) IsOutbound added in v0.2.5

func (pkt *Base) IsOutbound() bool

IsOutbound checks if the packet is outbound.

func (*Base) Layers added in v0.6.9

func (pkt *Base) Layers() gopacket.Packet

Layers returns the parsed layer data.

func (*Base) LoadPacketData added in v0.6.9

func (pkt *Base) LoadPacketData() error

LoadPacketData loads packet data from the integration, if not yet done.

func (*Base) MatchesAddress added in v0.2.5

func (pkt *Base) MatchesAddress(remote bool, protocol IPProtocol, network *net.IPNet, port uint16) bool

MatchesAddress checks if a the packet matches a given endpoint (remote or local) in protocol, network and port.

Comparison matrix:


Local Dst Src Remote Src Dst

func (*Base) MatchesIP added in v0.2.5

func (pkt *Base) MatchesIP(endpoint bool, network *net.IPNet) bool

MatchesIP checks if a the packet matches a given endpoint (remote or local) IP.

Comparison matrix:


Local Dst Src Remote Src Dst

func (*Base) Payload added in v0.2.5

func (pkt *Base) Payload() []byte

Payload returns the raw Layer 5 Network Data.

func (*Base) Raw added in v0.6.9

func (pkt *Base) Raw() []byte

Raw returns the raw Layer 3 Network Data.

func (*Base) SetCtx added in v0.2.5

func (pkt *Base) SetCtx(ctx context.Context)

SetCtx sets the packet context.

func (*Base) SetInbound added in v0.2.5

func (pkt *Base) SetInbound()

SetInbound sets a the packet direction to inbound. This must only used when initializing the packet structure.

func (*Base) SetOutbound added in v0.2.5

func (pkt *Base) SetOutbound()

SetOutbound sets a the packet direction to outbound. This must only used when initializing the packet structure.

func (*Base) SetPacketInfo added in v0.2.5

func (pkt *Base) SetPacketInfo(packetInfo Info)

SetPacketInfo sets a new packet Info. This must only used when initializing the packet structure.

func (*Base) String added in v0.2.5

func (pkt *Base) String() string

type IPProtocol

type IPProtocol uint8

IPProtocol represents an IP protocol.

func (IPProtocol) String

func (p IPProtocol) String() string

String returns the string representation (abbreviation) of the protocol.

type IPVersion

type IPVersion uint8

IPVersion represents an IP version.

func (IPVersion) ByteSize

func (v IPVersion) ByteSize() int

ByteSize returns the byte size of the ip, IPv4 = 4 bytes, IPv6 = 16

func (IPVersion) String

func (v IPVersion) String() string

String returns the string representation of the IP version: "IPv4" or "IPv6".

type Info added in v0.2.5

type Info struct {
	Inbound  bool
	InTunnel bool

	Version          IPVersion
	Protocol         IPProtocol
	SrcPort, DstPort uint16
	Src, Dst         net.IP

Info holds IP and TCP/UDP header information

func (*Info) LocalIP added in v0.2.5

func (pi *Info) LocalIP() net.IP

LocalIP returns the local IP of the packet.

func (*Info) LocalPort added in v0.2.5

func (pi *Info) LocalPort() uint16

LocalPort returns the local port of the packet.

func (*Info) RemoteIP added in v0.2.5

func (pi *Info) RemoteIP() net.IP

RemoteIP returns the remote IP of the packet.

func (*Info) RemotePort added in v0.2.5

func (pi *Info) RemotePort() uint16

RemotePort returns the remote port of the packet.

type Packet

type Packet interface {
	Accept() error
	Block() error
	Drop() error
	PermanentAccept() error
	PermanentBlock() error
	PermanentDrop() error
	RerouteToNameserver() error
	RerouteToTunnel() error
	FastTrackedByIntegration() bool

	// INFO
	Ctx() context.Context
	Info() *Info
	IsInbound() bool
	IsOutbound() bool
	HasPorts() bool
	GetConnectionID() string

	LoadPacketData() error
	Layers() gopacket.Packet
	Raw() []byte
	Payload() []byte

	MatchesAddress(bool, IPProtocol, *net.IPNet, uint16) bool
	MatchesIP(bool, *net.IPNet) bool

	String() string
	FmtPacket() string
	FmtProtocol() string
	FmtRemoteIP() string
	FmtRemotePort() string
	FmtRemoteAddress() string

Packet is an interface to a network packet to provide object behaviour the same across all systems

type Verdict

type Verdict uint8

Verdict describes the decision on a packet.

const (
	DROP Verdict = iota


func (Verdict) String

func (v Verdict) String() string

String returns the string representation of the verdict.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL