gont

package
v2.6.7 Latest Latest
Warning

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

 Go to latest Published: Jul 8, 2024 License: Apache-2.0 Imports: 48 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	LinkTypeUser0 = 147
	LinkTypeTrace = LinkTypeUser0
)
View Source 
const (
	WithQdiscNetem = (1 << iota)
	WithQdiscTbf   = (1 << iota)
)
View Source 
const CGoPCAP = true

Variables

View Source 
var (
	DefaultIPv4Mask = net.IPNet{
		IP:   net.IPv4zero,
		Mask: net.CIDRMask(0, net.IPv4len*8),
	}

	DefaultIPv6Mask = net.IPNet{
		IP:   net.IPv6zero,
		Mask: net.CIDRMask(0, net.IPv6len*8),
	}
)
View Source 
var DefaultPreserveEnvVars = []string{
	"PATH",
}
View Source 
var IPv4loopback = net.IPv4(127, 0, 0, 1) //nolint:gochecknoglobals

IPv4loopback is the IPv4 loopback address (127.0.0.1)

View Source 
var Names = []string{}/* 120 elements not displayed */

Names is a list of well known persons in information theory / networking From: https://en.wikipedia.org/wiki/List_of_Internet_pioneers and https://www.internethalloffame.org/inductees/all

Functions

func CheckCaps 

func CheckCaps() error

CheckCaps checks if the current process has the required privileges to run Gont

func Exec 

func Exec(network, node string, args []string) error

func GenerateNetworkName 

func GenerateNetworkName() string

func GetRandomName 

func GetRandomName() string

func Identify 

func Identify() (string, string, error)

Identify returns the network and node name if the current process is running in a network netspace created by Gont

func NetworkNames 

func NetworkNames() []string

func NodeNames 

func NodeNames(network string) []string

func SerializePacket 

func SerializePacket(t *trace.Event) (data []byte, ci gopacket.CaptureInfo, err error)

func TeardownAllNetworks 

func TeardownAllNetworks() error

func TeardownNetwork 

func TeardownNetwork(network string) error

func TeardownNode 

func TeardownNode(network, node string) error

func TestConnectivity 

func TestConnectivity(hosts ...*Host) error

TestConnectivity performs ICMP ping tests between all pairs of nodes in the network

func Unshare 

func Unshare(network, node string) error

Types

type BaseNode 

type BaseNode struct {
	*Namespace

	BasePath string

	Interfaces []*Interface

	// Options
	ConfiguredInterfaces    []*Interface
	Tracer                  *Tracer
	Debugger                *Debugger
	ExistingNamespace       string
	ExistingDockerContainer string
	RedirectToLog           bool
	EmptyDirs               []string
	Captures                []*Capture
	// contains filtered or unexported fields
}

func (*BaseNode) AddDefaultRoute 

func (n *BaseNode) AddDefaultRoute(gw net.IP) error

AddDefaultRoute adds a default route for this node by providing a default gateway.

func (*BaseNode) AddInterface 

func (n *BaseNode) AddInterface(i *Interface)

AddInterface adds an interface to the list of configured interfaces

func (*BaseNode) AddRoute 

func (n *BaseNode) AddRoute(r *nl.Route) error

AddRoute adds a route to the node.

func (*BaseNode) BuildGo 

func (n *BaseNode) BuildGo(fileOrPkg string, args ...any) (*os.File, error)

func (*BaseNode) Close 

func (n *BaseNode) Close() error

func (*BaseNode) Command 

func (n *BaseNode) Command(name string, args ...any) *Cmd

func (*BaseNode) ConfigureInterface 

func (n *BaseNode) ConfigureInterface(i *Interface) error

func (*BaseNode) EnableForwarding 

func (n *BaseNode) EnableForwarding() error

EnableForwarding enables forwarding for both IPv4 and IPv6 protocols in the kernel for all interfaces

func (*BaseNode) Interface 

func (n *BaseNode) Interface(name string) *Interface

func (*BaseNode) Name 

func (n *BaseNode) Name() string

func (*BaseNode) NetNSHandle 

func (n *BaseNode) NetNSHandle() netns.NsHandle

func (*BaseNode) NetlinkHandle 

func (n *BaseNode) NetlinkHandle() *nl.Handle

func (*BaseNode) Network 

func (n *BaseNode) Network() *Network

Network returns the network to which this node belongs

func (*BaseNode) NftConn 

func (n *BaseNode) NftConn() *nft.Conn

func (*BaseNode) Run 

func (n *BaseNode) Run(cmd string, args ...any) (*Cmd, error)

func (*BaseNode) RunGo 

func (n *BaseNode) RunGo(fileOrPkg string, args ...any) (*Cmd, error)

func (*BaseNode) Start 

func (n *BaseNode) Start(cmd string, args ...any) (*Cmd, error)

func (*BaseNode) StartGo 

func (n *BaseNode) StartGo(fileOrPkg string, args ...any) (*Cmd, error)

func (*BaseNode) String 

func (n *BaseNode) String() string

func (*BaseNode) Teardown 

func (n *BaseNode) Teardown() error

func (*BaseNode) WriteProcFS 

func (n *BaseNode) WriteProcFS(path, value string) error

WriteProcFS write a value to a path within the ProcFS by entering the namespace of this node.

type BaseNodeOption 

type BaseNodeOption interface {
	ApplyBaseNode(n *BaseNode)
}

type BridgeOption 

type BridgeOption interface {
	ApplyBridge(br *nl.Bridge)
}

type Callback 

type Callback func() error

type Capture 

type Capture struct {
	// Options
	SnapshotLength int
	Promiscuous    bool
	Comment        string
	Timeout        time.Duration
	LogKeys        bool
	FlushEach      uint64

	// Filter options
	FilterInterface    CaptureFilterInterfaceFunc
	FilterPackets      CaptureFilterPacketFunc
	FilterExpression   string
	FilterInstructions []bpf.Instruction

	// Output options
	Files       []*os.File
	Filenames   []string
	Channels    []chan CapturePacket
	Callbacks   []CaptureCallbackFunc
	Pipenames   []string
	ListenAddrs []string
	// contains filtered or unexported fields
}

func NewCapture 

func NewCapture(opts ...CaptureOption) *Capture

func (*Capture) ApplyBaseNode 

func (c *Capture) ApplyBaseNode(n *BaseNode)

func (*Capture) ApplyInterface 

func (c *Capture) ApplyInterface(i *Interface)

func (*Capture) ApplyNetwork 

func (c *Capture) ApplyNetwork(n *Network)

func (*Capture) ApplyTracer 

func (c *Capture) ApplyTracer(n *Tracer)

func (*Capture) Close 

func (c *Capture) Close() error

func (*Capture) Count 

func (c *Capture) Count() uint64

Count returns the total number of captured packets

func (*Capture) Flush 

func (c *Capture) Flush() error

type CaptureCallbackFunc 

type CaptureCallbackFunc func(pkt CapturePacket)

type CaptureFilterInterfaceFunc 

type CaptureFilterInterfaceFunc func(i *Interface) bool

type CaptureFilterPacketFunc 

type CaptureFilterPacketFunc func(p *CapturePacket) bool

type CaptureOption 

type CaptureOption interface {
	ApplyCapture(n *Capture)
}

type CapturePacket 

type CapturePacket struct {
	gopacket.CaptureInfo
	Data []byte

	Interface *captureInterface
}

func (CapturePacket) Decode 

func (p CapturePacket) Decode(dOpts gopacket.DecodeOptions) gopacket.Packet

func (CapturePacket) Time 

func (p CapturePacket) Time() time.Time

type Cmd 

type Cmd struct {
	*exec.Cmd

	// Options
	Tracer          *Tracer
	Debugger        *Debugger
	RedirectToLog   bool
	DisableASLR     bool
	Context         context.Context
	PreserveEnvVars []string

	StdoutWriters []io.Writer
	StderrWriters []io.Writer
	// contains filtered or unexported fields
}

func (*Cmd) CombinedOutput 

func (c *Cmd) CombinedOutput() ([]byte, error)

CombinedOutput runs the command and returns its combined standard output and standard error.

func (*Cmd) Run 

func (c *Cmd) Run() error

func (*Cmd) Start 

func (c *Cmd) Start() error

func (*Cmd) StderrPipe 

func (c *Cmd) StderrPipe() (io.ReadCloser, error)

func (*Cmd) StdoutPipe 

func (c *Cmd) StdoutPipe() (io.ReadCloser, error)

func (*Cmd) Wait 

func (c *Cmd) Wait() error

type CmdOption 

type CmdOption interface {
	ApplyCmd(*Cmd)
}

type Debugger 

type Debugger struct {
	// Options
	BreakOnEntry         bool
	DetachOnExit         bool
	Tracepoints          []Tracepoint
	Tracers              []*Tracer
	ListenAddr           string
	DebugInfoDirectories []string
	// contains filtered or unexported fields
}

func NewDebugger 

func NewDebugger(opts ...DebuggerOption) *Debugger

func (*Debugger) ApplyBaseNode 

func (d *Debugger) ApplyBaseNode(n *BaseNode)

func (*Debugger) ApplyCmd 

func (d *Debugger) ApplyCmd(c *Cmd)

func (*Debugger) ApplyNetwork 

func (d *Debugger) ApplyNetwork(n *Network)

func (*Debugger) Close 

func (d *Debugger) Close() error

func (*Debugger) WriteVSCodeConfigs 

func (d *Debugger) WriteVSCodeConfigs(dir string, stopOnEntry bool) error

WriteVSCodeConfigs generates Visual Studio Code Launch and Task configuration files (tasks.json, launch.json) in the given workspace directory. The launch configuration is dynamically generated from the current active Delve debugger instances If an empty dir is passed, we attempt to find the workspace directory by searching for a parent directory which contains either a .vscode, go.mod or .git

type DebuggerOption 

type DebuggerOption interface {
	ApplyDebugger(*Debugger)
}

type DeviceGroup 

type DeviceGroup uint32
const (
	DeviceGroupDefault    DeviceGroup = 0
	DeviceGroupSouthBound DeviceGroup = 1000 + iota
	DeviceGroupNorthBound
)

type ExecCmdOption 

type ExecCmdOption interface {
	ApplyExecCmd(*exec.Cmd)
}

type Filter 

type Filter struct {
	Family nft.TableFamily
	Table  *nft.Table

	Input   *nft.Chain
	Output  *nft.Chain
	Forward *nft.Chain
	// contains filtered or unexported fields
}

func NewFilter 

func NewFilter(c *nft.Conn) (*Filter, error)

func (*Filter) AddRule 

func (f *Filter) AddRule(h FilterHook, exprs ...expr.Any)

func (*Filter) Flush 

func (f *Filter) Flush() error

type FilterHook 

type FilterHook int
const (
	FilterInput FilterHook = iota
	FilterOutput
	FilterForward
)

type FilterRule 

type FilterRule struct {
	Exprs []expr.Any

	Hook FilterHook
}

func (FilterRule) ApplyHost 

func (fr FilterRule) ApplyHost(h *Host)

type GoBuildFlags 

type GoBuildFlags []string

type GoBuildFlagsOption 

type GoBuildFlagsOption interface {
	ApplyGoBuildFlags(*GoBuildFlags)
}

type Host 

type Host struct {
	*BaseNode

	Filter *Filter

	// Options
	FilterRules []*FilterRule
	Routes      []*nl.Route
}

func HostNode 

func HostNode(n *Network) *Host

func (*Host) ApplyInterface 

func (h *Host) ApplyInterface(i *Interface)

Options

func (*Host) ConfigureInterface 

func (h *Host) ConfigureInterface(i *Interface) error
func (h *Host) ConfigureLinks() error

ConfigureLinks adds links to other nodes which have been configured by functional options

func (*Host) LookupAddress 

func (h *Host) LookupAddress(n string) *net.IPAddr

func (*Host) Ping 

func (h *Host) Ping(o *Host) (*ping.Statistics, error)

func (*Host) PingWithNetwork 

func (h *Host) PingWithNetwork(o *Host, net string) (*ping.Statistics, error)

func (*Host) PingWithOptions 

func (h *Host) PingWithOptions(o *Host, net string, count int, timeout time.Duration, intv time.Duration, output bool) (*ping.Statistics, error)

func (*Host) Traceroute 

func (h *Host) Traceroute(o *Host, opts ...any) error

type HostOption 

type HostOption interface {
	ApplyHost(h *Host)
}

type Interface 

type Interface struct {
	Name string
	Node Node

	Link  nl.Link
	Flags int

	// Options
	Netem     nl.NetemQdiscAttrs
	Tbf       nl.Tbf
	EnableDAD bool
	LinkAttrs nl.LinkAttrs
	Addresses []net.IPNet
	Captures  []*Capture
}

func NewInterface 

func NewInterface(name string, opts ...Option) *Interface

func (*Interface) AddAddress 

func (i *Interface) AddAddress(a *net.IPNet) error

func (*Interface) ApplyBaseNode 

func (i *Interface) ApplyBaseNode(n *BaseNode)

func (*Interface) Close 

func (i *Interface) Close() error

func (*Interface) DeleteAddress 

func (i *Interface) DeleteAddress(a *net.IPNet) error

func (Interface) IsLoopback 

func (i Interface) IsLoopback() bool

func (*Interface) SetDown 

func (i *Interface) SetDown() error

func (*Interface) SetUp 

func (i *Interface) SetUp() error

func (Interface) String 

func (i Interface) String() string

type InterfaceOption 

type InterfaceOption interface {
	ApplyInterface(n *Interface)
}

type LinkOption 

type LinkOption interface {
	ApplyLink(a *nl.LinkAttrs)
}

type NAT 

type NAT struct {
	*Router

	Table       *nft.Table
	Input       *nft.Chain
	Forward     *nft.Chain
	PostRouting *nft.Chain

	// Options
	Persistent    bool
	Random        bool
	FullyRandom   bool
	SourcePortMin int
	SourcePortMax int
}

func (*NAT) ApplyInterface 

func (n *NAT) ApplyInterface(i *Interface)

type NATOption 

type NATOption interface {
	ApplyNAT(n *NAT)
}

type Namespace 

type Namespace struct {
	netns.NsHandle

	Name string
	// contains filtered or unexported fields
}

func NewNamespace 

func NewNamespace(name string) (*Namespace, error)

func (*Namespace) Close 

func (ns *Namespace) Close() error

func (*Namespace) Enter 

func (ns *Namespace) Enter() (func(), error)

func (*Namespace) RunFunc 

func (ns *Namespace) RunFunc(cb Callback) error

type Network 

type Network struct {
	Name string

	HostNode *Host
	VarPath  string
	TmpPath  string

	// Options
	Persistent    bool
	NSPrefix      string
	Captures      []*Capture
	Debugger      *Debugger
	Tracer        *Tracer
	RedirectToLog bool
	// contains filtered or unexported fields
}

func NewNetwork 

func NewNetwork(name string, opts ...NetworkOption) (*Network, error)

func (*Network) AddHost 

func (n *Network) AddHost(name string, opts ...Option) (*Host, error)

func (*Network) AddHostNAT 

func (n *Network) AddHostNAT(name string, opts ...Option) (*NAT, error)
func (n *Network) AddLink(l, r *Interface, opts ...Option) error

func (*Network) AddNAT 

func (n *Network) AddNAT(name string, opts ...Option) (*NAT, error)

func (*Network) AddNode 

func (n *Network) AddNode(name string, opts ...Option) (*BaseNode, error)

func (*Network) AddRouter 

func (n *Network) AddRouter(name string, opts ...Option) (*Router, error)

func (*Network) AddSwitch 

func (n *Network) AddSwitch(name string, opts ...Option) (*Switch, error)

AddSwitch adds a new Linux virtual bridge in a dedicated namespace

func (*Network) Close 

func (n *Network) Close() error

func (*Network) ForEachHost 

func (n *Network) ForEachHost(cb func(h *Host))

func (*Network) GenerateConfigFiles 

func (n *Network) GenerateConfigFiles() error

func (*Network) GenerateHostsFile 

func (n *Network) GenerateHostsFile() error

GenerateHostsFile writes the addresses and host names of all nodes into a file located at /run/gont/<network>/files/etc/hosts

Processes started via BaseNode.Run or BaseNode.Start, will see this file bind mounted at /etc/hosts

func (*Network) Hosts 

func (n *Network) Hosts() []*Host

func (*Network) KeyLogPipe 

func (n *Network) KeyLogPipe(secretsType uint32) (*os.File, error)

func (*Network) Nodes 

func (n *Network) Nodes() []Node

func (*Network) Register 

func (n *Network) Register(m Node)

func (*Network) Routers 

func (n *Network) Routers() []*Router

func (*Network) String 

func (n *Network) String() string

func (*Network) Switches 

func (n *Network) Switches() []*Switch

func (*Network) Teardown 

func (n *Network) Teardown() error

func (*Network) WriteHostsFile 

func (n *Network) WriteHostsFile(f io.Writer) error

type NetworkOption 

type NetworkOption interface {
	ApplyNetwork(n *Network)
}

type Node 

type Node interface {
	Close() error
	Teardown() error

	// Getters
	Name() string
	String() string
	Network() *Network
	Interface(name string) *Interface
	NetNSHandle() netns.NsHandle
	NetlinkHandle() *nl.Handle

	RunFunc(cb Callback) error
	ConfigureInterface(i *Interface) error
}

type Option 

type Option any

Option is the base type for all functional options.

type Router 

type Router struct {
	*Host
}

func (*Router) ApplyInterface 

func (h *Router) ApplyInterface(i *Interface)

type RouterOption 

type RouterOption interface {
	ApplyRouter(r *Router)
}

type Switch 

type Switch struct {
	*BaseNode
}

Switch is an abstraction for a Linux virtual bridge

func (*Switch) ApplyInterface 

func (sw *Switch) ApplyInterface(i *Interface)

func (*Switch) ConfigureInterface 

func (sw *Switch) ConfigureInterface(i *Interface) error

ConfigureInterface attaches an existing interface to a bridge interface

type SwitchOption 

type SwitchOption interface {
	ApplySwitch(sw *Switch)
}

type TraceOption 

type TraceOption interface {
	ApplyTracer(t *Tracer)
}

type Tracepoint 

type Tracepoint struct {
	// Options
	api.Breakpoint
	Location string
	Message  string
}

func NewTracepoint 

func NewTracepoint(opts ...TracepointOption) Tracepoint

func (Tracepoint) ApplyDebugger 

func (tp Tracepoint) ApplyDebugger(d *Debugger)

func (*Tracepoint) IsWatchpoint 

func (tp *Tracepoint) IsWatchpoint() bool

type TracepointOption 

type TracepointOption interface {
	ApplyTracepoint(*Tracepoint)
}

type Tracer 

type Tracer struct {
	// Output options
	Files     []*os.File
	Filenames []string
	Channels  []chan trace.Event
	Callbacks []trace.EventCallback
	Captures  []*Capture
	// contains filtered or unexported fields
}

func NewTracer 

func NewTracer(opts ...TraceOption) *Tracer

func (*Tracer) ApplyBaseNode 

func (t *Tracer) ApplyBaseNode(n *BaseNode)

func (*Tracer) ApplyCmd 

func (t *Tracer) ApplyCmd(c *Cmd)

func (*Tracer) ApplyDebugger 

func (t *Tracer) ApplyDebugger(d *Debugger)

func (*Tracer) ApplyNetwork 

func (t *Tracer) ApplyNetwork(n *Network)

func (*Tracer) Close 

func (t *Tracer) Close() error

func (*Tracer) Flush 

func (t *Tracer) Flush() error

func (*Tracer) Pipe 

func (t *Tracer) Pipe() (*os.File, error)

func (*Tracer) Start 

func (t *Tracer) Start() error

type VethOption 

type VethOption interface {
	ApplyVeth(ve *nl.Veth)
}

Source Files

View all Source files

Directories

Path Synopsis
Package options contains all the general options for configuring the general objects like hosts, switches, routers and interfaces
 Package options contains all the general options for configuring the general objects like hosts, switches, routers and interfaces
capture
Package capture contains the options to configure to packet capturing
 Package capture contains the options to configure to packet capturing
cmd
debug
filters
Package filters contains the options for configuring NFTables filtering
 Package filters contains the options for configuring NFTables filtering
tc
Package tc contains the options for configuring per-interface Traffic Control (TC) queuing disciplines
 Package tc contains the options for configuring per-interface Traffic Control (TC) queuing disciplines
trace

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.