hostinet

package
v0.0.0-...-648dfe1 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2026 License: Apache-2.0, BSD-3-Clause, MIT Imports: 43 Imported by: 4

Documentation

Overview

Package hostinet implements AF_INET and AF_INET6 sockets using the host's network stack.

Index

Constants

This section is empty.

Variables

View Source 
var AllowAllProtocols = -1

AllowAllProtocols indicates that all protocols are allowed by the stack and in the syscall filters.

View Source 
var AllowedRawSocketTypes = []AllowedSocketType{
	{unix.AF_INET, unix.SOCK_RAW, unix.IPPROTO_RAW},
	{unix.AF_INET, unix.SOCK_RAW, unix.IPPROTO_TCP},
	{unix.AF_INET, unix.SOCK_RAW, unix.IPPROTO_UDP},
	{unix.AF_INET, unix.SOCK_RAW, unix.IPPROTO_ICMP},

	{unix.AF_INET6, unix.SOCK_RAW, unix.IPPROTO_RAW},
	{unix.AF_INET6, unix.SOCK_RAW, unix.IPPROTO_TCP},
	{unix.AF_INET6, unix.SOCK_RAW, unix.IPPROTO_UDP},
	{unix.AF_INET6, unix.SOCK_RAW, unix.IPPROTO_ICMPV6},

	{unix.AF_PACKET, unix.SOCK_DGRAM, AllowAllProtocols},
	{unix.AF_PACKET, unix.SOCK_RAW, AllowAllProtocols},
}

AllowedRawSocketTypes are the socket types which are supported by hostinet with raw sockets enabled.

View Source 
var AllowedSocketTypes = []AllowedSocketType{

	{unix.AF_INET, unix.SOCK_STREAM, unix.IPPROTO_TCP},
	{unix.AF_INET, unix.SOCK_DGRAM, unix.IPPROTO_UDP},
	{unix.AF_INET, unix.SOCK_DGRAM, unix.IPPROTO_ICMP},

	{unix.AF_INET6, unix.SOCK_STREAM, unix.IPPROTO_TCP},
	{unix.AF_INET6, unix.SOCK_DGRAM, unix.IPPROTO_UDP},
	{unix.AF_INET6, unix.SOCK_DGRAM, unix.IPPROTO_ICMPV6},
}

AllowedSocketTypes are the socket types which are supported by hostinet. These are used to validate the arguments to socket(), and also to generate syscall filters.

View Source 
var SockOpts = []SockOpt{
	{linux.SOL_IP, linux.IP_ADD_MEMBERSHIP, 0, false, true, false},
	{linux.SOL_IP, linux.IP_DROP_MEMBERSHIP, 0, false, true, false},
	{linux.SOL_IP, linux.IP_HDRINCL, sizeofInt32, true, true, false},
	{linux.SOL_IP, linux.IP_MULTICAST_IF, 0, true, true, false},
	{linux.SOL_IP, linux.IP_MULTICAST_LOOP, 0, true, true, false},
	{linux.SOL_IP, linux.IP_MULTICAST_TTL, 0, true, true, false},
	{linux.SOL_IP, linux.IP_MTU_DISCOVER, 0, true, true, false},
	{linux.SOL_IP, linux.IP_PKTINFO, sizeofInt32, true, true, false},
	{linux.SOL_IP, linux.IP_RECVERR, sizeofInt32, true, true, false},
	{linux.SOL_IP, linux.IP_RECVORIGDSTADDR, sizeofInt32, true, true, false},
	{linux.SOL_IP, linux.IP_RECVTOS, sizeofInt32, true, true, false},
	{linux.SOL_IP, linux.IP_RECVTTL, sizeofInt32, true, true, false},
	{linux.SOL_IP, linux.IP_TOS, 0, true, true, false},
	{linux.SOL_IP, linux.IP_TTL, sizeofInt32, true, true, true},
	{linux.SOL_IP, linux.SO_ORIGINAL_DST, uint64(linux.SockAddrInetSize), true, false, false},

	{linux.SOL_IPV6, linux.IPV6_CHECKSUM, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_MULTICAST_HOPS, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_RECVERR, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_RECVHOPLIMIT, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_RECVORIGDSTADDR, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_RECVPKTINFO, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_RECVTCLASS, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_TCLASS, sizeofInt32, true, true, true},
	{linux.SOL_IPV6, linux.IPV6_UNICAST_HOPS, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IPV6_V6ONLY, sizeofInt32, true, true, false},
	{linux.SOL_IPV6, linux.IP6T_ORIGINAL_DST, uint64(linux.SockAddrInet6Size), true, false, false},

	{linux.SOL_SOCKET, linux.SO_ACCEPTCONN, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_BINDTODEVICE, 0, true, true, false},
	{linux.SOL_SOCKET, linux.SO_BROADCAST, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_ERROR, sizeofInt32, true, false, false},
	{linux.SOL_SOCKET, linux.SO_KEEPALIVE, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_LINGER, linux.SizeOfLinger, true, true, false},
	{linux.SOL_SOCKET, linux.SO_NO_CHECK, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_OOBINLINE, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_PASSCRED, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_RCVBUF, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_RCVBUFFORCE, sizeofInt32, false, true, false},
	{linux.SOL_SOCKET, linux.SO_RCVLOWAT, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_REUSEADDR, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_REUSEPORT, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_SNDBUF, sizeofInt32, true, true, false},
	{linux.SOL_SOCKET, linux.SO_TIMESTAMP, sizeofInt32, true, true, false},

	{linux.SOL_TCP, linux.TCP_CONGESTION, 0, true, true, false},
	{linux.SOL_TCP, linux.TCP_CORK, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_DEFER_ACCEPT, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_INFO, uint64(linux.SizeOfTCPInfo), true, false, true},
	{linux.SOL_TCP, linux.TCP_INQ, sizeofInt32, true, true, false},
	{linux.SOL_TCP, linux.TCP_KEEPCNT, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_KEEPIDLE, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_KEEPINTVL, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_LINGER2, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_MAXSEG, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_NODELAY, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_QUICKACK, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_SYNCNT, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_USER_TIMEOUT, sizeofInt32, true, true, true},
	{linux.SOL_TCP, linux.TCP_WINDOW_CLAMP, sizeofInt32, true, true, true},

	{linux.SOL_ICMPV6, linux.ICMPV6_FILTER, uint64(linux.ICMP6FilterSize), true, true, true},
}

SockOpts are the socket options supported by hostinet by making syscalls to the host.

Note the following socket options are supported but do not need syscalls to the host, so do not appear on this list:

  • SO_TYPE, SO_PROTOCOL, SO_DOMAIN are handled at the syscall level in syscalls/sys_socket.go.
  • SO_SNDTIMEOU, SO_RCVTIMEO are handled internally by setting the embedded socket.SendReceiveTimeout.

Functions

This section is empty.

Types

type AllowedSocketType 

type AllowedSocketType struct {
	Family int
	Type   int

	// Protocol of AllowAllProtocols indicates that all protocols are
	// allowed.
	Protocol int
}

AllowedSocketType is a tuple of socket family, type, and protocol.

type SockOpt 

type SockOpt struct {
	// Level the socket option applies to.
	Level uint64
	// Name of the option.
	Name uint64
	// Size of the parameter. A size of 0 indicates that any size is
	// allowed (used for string or other variable-length types).
	Size uint64
	// Support getsockopt on this option.
	AllowGet bool
	// Support setsockopt on this option.
	AllowSet bool
	// AllowTruncatedGet allows getsockopt with optlen < Size.
	AllowTruncatedGet bool
}

SockOpt is used to generate get/setsockopt handlers and filters.

type Socket 

type Socket struct {
	vfs.FileDescriptionDefaultImpl
	vfs.LockFD
	// We store metadata for hostinet sockets internally. Technically, we should
	// access metadata (e.g. through stat, chmod) on the host for correctness,
	// but this is not very useful for inet socket fds, which do not belong to a
	// concrete file anyway.
	vfs.DentryMetadataFileDescriptionImpl
	socket.SendReceiveTimeout
	// contains filtered or unexported fields
}

Socket implements socket.Socket (and by extension, vfs.FileDescriptionImpl) for host sockets.

+stateify savable

func (*Socket) Accept 

func (s *Socket) Accept(t *kernel.Task, peerRequested bool, flags int, blocking bool) (int32, linux.SockAddr, uint32, *syserr.Error)

Accept implements socket.Socket.Accept.

func (*Socket) Bind 

func (s *Socket) Bind(_ *kernel.Task, sockaddr []byte) *syserr.Error

Bind implements socket.Socket.Bind.

func (*Socket) Connect 

func (s *Socket) Connect(t *kernel.Task, sockaddr []byte, blocking bool) *syserr.Error

Connect implements socket.Socket.Connect.

func (*Socket) Epollable 

func (s *Socket) Epollable() bool

Epollable implements FileDescriptionImpl.Epollable.

func (*Socket) EventRegister 

func (s *Socket) EventRegister(e *waiter.Entry) error

EventRegister implements waiter.Waitable.EventRegister.

func (*Socket) EventUnregister 

func (s *Socket) EventUnregister(e *waiter.Entry)

EventUnregister implements waiter.Waitable.EventUnregister.

func (*Socket) GetPeerCreds 

func (s *Socket) GetPeerCreds(t *kernel.Task) (marshal.Marshallable, *syserr.Error)

GetPeerCreds implements socket.Socket.GetPeerCreds

func (*Socket) GetPeerName 

func (s *Socket) GetPeerName(t *kernel.Task) (linux.SockAddr, uint32, *syserr.Error)

GetPeerName implements socket.Socket.GetPeerName.

func (*Socket) GetSockName 

func (s *Socket) GetSockName(t *kernel.Task) (linux.SockAddr, uint32, *syserr.Error)

GetSockName implements socket.Socket.GetSockName.

func (*Socket) GetSockOpt 

func (s *Socket) GetSockOpt(t *kernel.Task, level, name int, optValAddr hostarch.Addr, optLen int) (marshal.Marshallable, *syserr.Error)

GetSockOpt implements socket.Socket.GetSockOpt.

func (*Socket) Ioctl 

func (s *Socket) Ioctl(ctx context.Context, uio usermem.IO, sysno uintptr, args arch.SyscallArguments) (uintptr, error)

Ioctl implements vfs.FileDescriptionImpl.

func (*Socket) Listen 

func (s *Socket) Listen(_ *kernel.Task, backlog int) *syserr.Error

Listen implements socket.Socket.Listen.

func (*Socket) PRead 

func (s *Socket) PRead(ctx context.Context, dst usermem.IOSequence, offset int64, opts vfs.ReadOptions) (int64, error)

PRead implements vfs.FileDescriptionImpl.PRead.

func (*Socket) PWrite 

func (s *Socket) PWrite(ctx context.Context, dst usermem.IOSequence, offset int64, opts vfs.WriteOptions) (int64, error)

PWrite implements vfs.FileDescriptionImpl.

func (*Socket) Read 

func (s *Socket) Read(ctx context.Context, dst usermem.IOSequence, opts vfs.ReadOptions) (int64, error)

Read implements vfs.FileDescriptionImpl.

func (*Socket) Readiness 

func (s *Socket) Readiness(mask waiter.EventMask) waiter.EventMask

Readiness implements waiter.Waitable.Readiness.

func (*Socket) RecvMsg 

func (s *Socket) RecvMsg(t *kernel.Task, dst usermem.IOSequence, flags int, haveDeadline bool, deadline ktime.Time, senderRequested bool, controlLen uint64) (int, int, linux.SockAddr, uint32, socket.ControlMessages, *syserr.Error)

RecvMsg implements socket.Socket.RecvMsg.

func (*Socket) Release 

func (s *Socket) Release(ctx context.Context)

Release implements vfs.FileDescriptionImpl.Release.

func (*Socket) SendMsg 

func (s *Socket) SendMsg(t *kernel.Task, src usermem.IOSequence, to []byte, flags int, haveDeadline bool, deadline ktime.Time, controlMessages socket.ControlMessages) (int, *syserr.Error)

SendMsg implements socket.Socket.SendMsg.

func (*Socket) SetSockOpt 

func (s *Socket) SetSockOpt(t *kernel.Task, level, name int, opt []byte) *syserr.Error

SetSockOpt implements socket.Socket.SetSockOpt.

func (*Socket) Shutdown 

func (s *Socket) Shutdown(_ *kernel.Task, how int) *syserr.Error

Shutdown implements socket.Socket.Shutdown.

func (*Socket) State 

func (s *Socket) State() uint32

State implements socket.Socket.State.

func (*Socket) Type 

func (s *Socket) Type() (family int, skType linux.SockType, protocol int)

Type implements socket.Socket.Type.

func (*Socket) Write 

func (s *Socket) Write(ctx context.Context, src usermem.IOSequence, opts vfs.WriteOptions) (int64, error)

Write implements vfs.FileDescriptionImpl.

type Stack 

type Stack struct {
	// contains filtered or unexported fields
}

Stack implements inet.Stack for host sockets. Most fields are derived from the host network configuration. During restore, ReplaceConfig overwrites the deserialized Stack with values from the destination host.

+stateify savable

func NewStack 

func NewStack() *Stack

NewStack returns an empty Stack containing no configuration.

func (*Stack) AddInterfaceAddr 

func (*Stack) AddInterfaceAddr(idx int32, addr inet.InterfaceAddr) error

AddInterfaceAddr implements inet.Stack.AddInterfaceAddr.

func (*Stack) CleanupEndpoints 

func (*Stack) CleanupEndpoints() []stack.TransportEndpoint

CleanupEndpoints implements inet.Stack.CleanupEndpoints.

func (*Stack) Configure 

func (s *Stack) Configure(allowRawSockets bool) error

Configure sets up the stack using the current state of the host network.

func (*Stack) Destroy 

func (s *Stack) Destroy()

Destroy implements inet.Stack.Destroy.

func (*Stack) GetRemoveConf 

func (*Stack) GetRemoveConf() bool

GetRemoveConf implements inet.Stack.GetRemoveConf.

func (*Stack) InterfaceAddrs 

func (s *Stack) InterfaceAddrs() map[int32][]inet.InterfaceAddr

InterfaceAddrs implements inet.Stack.InterfaceAddrs.

func (*Stack) InterfaceIDs 

func (s *Stack) InterfaceIDs() []int32

InterfaceIDs implements inet.Stack.InterfaceIDs. hostinet reads interfaces from the host each time, so we sort by ID to ensure a deterministic order consistent with interface registration order.

func (*Stack) Interfaces 

func (s *Stack) Interfaces() map[int32]inet.Interface

Interfaces implements inet.Stack.Interfaces.

func (*Stack) NewRoute 

func (*Stack) NewRoute(ctx context.Context, msg *nlmsg.Message) *syserr.Error

NewRoute implements inet.Stack.NewRoute.

func (*Stack) Pause 

func (*Stack) Pause()

Pause implements inet.Stack.Pause.

func (*Stack) PortRange 

func (*Stack) PortRange() (uint16, uint16)

PortRange implements inet.Stack.PortRange.

func (*Stack) RegisteredEndpoints 

func (*Stack) RegisteredEndpoints() []stack.TransportEndpoint

RegisteredEndpoints implements inet.Stack.RegisteredEndpoints.

func (*Stack) RemoveInterface 

func (*Stack) RemoveInterface(ctx context.Context, idx int32) error

RemoveInterface implements inet.Stack.RemoveInterface.

func (*Stack) RemoveInterfaceAddr 

func (*Stack) RemoveInterfaceAddr(idx int32, addr inet.InterfaceAddr) error

RemoveInterfaceAddr implements inet.Stack.RemoveInterfaceAddr.

func (*Stack) RemoveRoute 

func (*Stack) RemoveRoute(ctx context.Context, msg *nlmsg.Message) *syserr.Error

RemoveRoute implements inet.Stack.RemoveRoute.

func (*Stack) ResetConfig 

func (s *Stack) ResetConfig()

ResetConfig implements inet.Stack.ResetConfig. It takes ownership of the freshly configured stack's host state, including its proc net files.

func (*Stack) Restore 

func (*Stack) Restore()

Restore implements inet.Stack.Restore.

func (*Stack) RestoreCleanupEndpoints 

func (*Stack) RestoreCleanupEndpoints([]stack.TransportEndpoint)

RestoreCleanupEndpoints implements inet.Stack.RestoreCleanupEndpoints.

func (*Stack) Resume 

func (*Stack) Resume()

Resume implements inet.Stack.Resume.

func (*Stack) RouteTable 

func (s *Stack) RouteTable() []inet.Route

RouteTable implements inet.Stack.RouteTable.

func (*Stack) SetFiles 

func (s *Stack) SetFiles(netDev, netSNMP *os.File)

SetFiles sets the host proc net files for the stack. It takes ownership of the files.

func (*Stack) SetForwarding 

func (*Stack) SetForwarding(tcpip.NetworkProtocolNumber, bool) error

SetForwarding implements inet.Stack.SetForwarding.

func (*Stack) SetInterface 

func (s *Stack) SetInterface(ctx context.Context, msg *nlmsg.Message) *syserr.Error

SetInterface implements inet.Stack.SetInterface.

func (*Stack) SetPortRange 

func (*Stack) SetPortRange(uint16, uint16) error

SetPortRange implements inet.Stack.SetPortRange.

func (*Stack) SetRemoveConf 

func (*Stack) SetRemoveConf(bool)

SetRemoveConf implements inet.Stack.SetRemoveConf.

func (*Stack) SetTCPReceiveBufferSize 

func (*Stack) SetTCPReceiveBufferSize(inet.TCPBufferSize) error

SetTCPReceiveBufferSize implements inet.Stack.SetTCPReceiveBufferSize.

func (*Stack) SetTCPRecovery 

func (*Stack) SetTCPRecovery(inet.TCPLossRecovery) error

SetTCPRecovery implements inet.Stack.SetTCPRecovery.

func (*Stack) SetTCPSACKEnabled 

func (*Stack) SetTCPSACKEnabled(bool) error

SetTCPSACKEnabled implements inet.Stack.SetTCPSACKEnabled.

func (*Stack) SetTCPSendBufferSize 

func (*Stack) SetTCPSendBufferSize(inet.TCPBufferSize) error

SetTCPSendBufferSize implements inet.Stack.SetTCPSendBufferSize.

func (*Stack) Statistics 

func (s *Stack) Statistics(stat any, arg string) error

Statistics implements inet.Stack.Statistics.

func (*Stack) Stats 

func (s *Stack) Stats() tcpip.Stats

Stats implements inet.Stack.Stats.

func (*Stack) SupportsIPv6 

func (s *Stack) SupportsIPv6() bool

SupportsIPv6 implements inet.Stack.SupportsIPv6.

func (*Stack) TCPReceiveBufferSize 

func (s *Stack) TCPReceiveBufferSize() (inet.TCPBufferSize, error)

TCPReceiveBufferSize implements inet.Stack.TCPReceiveBufferSize.

func (*Stack) TCPRecovery 

func (s *Stack) TCPRecovery() (inet.TCPLossRecovery, error)

TCPRecovery implements inet.Stack.TCPRecovery.

func (*Stack) TCPSACKEnabled 

func (s *Stack) TCPSACKEnabled() (bool, error)

TCPSACKEnabled implements inet.Stack.TCPSACKEnabled.

func (*Stack) TCPSendBufferSize 

func (s *Stack) TCPSendBufferSize() (inet.TCPBufferSize, error)

TCPSendBufferSize implements inet.Stack.TCPSendBufferSize.

Source Files

View all Source files

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.