README
¶
Netstack
Netstack is a network stack written in Go.
Getting started
Try it out on Linux by installing the tun_tcp_echo demo:
go install github.com/google/netstack/tcpip/sample/tun_tcp_echo
Create a TUN device with:
[sudo] ip tuntap add user <username> mode tun <device-name>
[sudo] ip link set <device-name> up
[sudo] ip addr add <ipv4-address>/<mask-length> dev <device-name>
Then run with:
tun_tcp_echo <device-name> <ipv4-address> <port>
Contributions
We would love to accept contributions, but we have not yet worked out how to handle them. Please contact us before sending any pull requests.
Whatever we do decide on will require signing the Google Contributor License. Please see CONTRIBUTING.md for more details.
Disclaimer
This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package dhcp implements a DHCP client and server as described in RFC 2131.
|
Package dhcp implements a DHCP client and server as described in RFC 2131. |
|
Package ilist provides the implementation of intrusive linked lists.
|
Package ilist provides the implementation of intrusive linked lists. |
|
Package sleep allows goroutines to efficiently sleep on multiple sources of notifications (wakers).
|
Package sleep allows goroutines to efficiently sleep on multiple sources of notifications (wakers). |
|
Package tcpip provides the interfaces and related types that users of the tcpip stack will use in order to create endpoints used to send and receive data over the network stack.
|
Package tcpip provides the interfaces and related types that users of the tcpip stack will use in order to create endpoints used to send and receive data over the network stack. |
|
adapters/gonet
Package gonet provides a Go net package compatible wrapper for a tcpip stack.
|
Package gonet provides a Go net package compatible wrapper for a tcpip stack. |
|
buffer
Package buffer provides the implementation of a buffer view.
|
Package buffer provides the implementation of a buffer view. |
|
checker
Package checker provides helper functions to check networking packets for validity.
|
Package checker provides helper functions to check networking packets for validity. |
|
header
Package header provides the implementation of the encoding and decoding of network protocol headers.
|
Package header provides the implementation of the encoding and decoding of network protocol headers. |
|
link/channel
Package channel provides the implemention of channel-based data-link layer endpoints.
|
Package channel provides the implemention of channel-based data-link layer endpoints. |
|
link/fdbased
Package fdbased provides the implemention of data-link layer endpoints backed by boundary-preserving file descriptors (e.g., TUN devices, seqpacket/datagram sockets).
|
Package fdbased provides the implemention of data-link layer endpoints backed by boundary-preserving file descriptors (e.g., TUN devices, seqpacket/datagram sockets). |
|
link/loopback
Package loopback provides the implemention of loopback data-link layer endpoints.
|
Package loopback provides the implemention of loopback data-link layer endpoints. |
|
link/sniffer
Package sniffer provides the implementation of data-link layer endpoints that wrap another endpoint and logs inbound and outbound packets.
|
Package sniffer provides the implementation of data-link layer endpoints that wrap another endpoint and logs inbound and outbound packets. |
|
network/arp
Package arp implements the ARP network protocol.
|
Package arp implements the ARP network protocol. |
|
network/fragmentation
Package fragmentation contains the implementation of IP fragmentation.
|
Package fragmentation contains the implementation of IP fragmentation. |
|
network/hash
Package hash contains utility functions for hashing.
|
Package hash contains utility functions for hashing. |
|
network/ipv4
Package ipv4 contains the implementation of the ipv4 network protocol.
|
Package ipv4 contains the implementation of the ipv4 network protocol. |
|
network/ipv6
Package ipv6 contains the implementation of the ipv6 network protocol.
|
Package ipv6 contains the implementation of the ipv6 network protocol. |
|
ports
Package ports provides PortManager that manages allocating, reserving and releasing ports.
|
Package ports provides PortManager that manages allocating, reserving and releasing ports. |
|
sample/tun_tcp_connect
command
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and connects to a peer.
|
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and connects to a peer. |
|
sample/tun_tcp_echo
command
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and listens on a port.
|
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and listens on a port. |
|
seqnum
Package seqnum defines the types and methods for TCP sequence numbers such that they fit in 32-bit words and work properly when overflows occur.
|
Package seqnum defines the types and methods for TCP sequence numbers such that they fit in 32-bit words and work properly when overflows occur. |
|
stack
Package stack provides the glue between networking protocols and the consumers of the networking stack.
|
Package stack provides the glue between networking protocols and the consumers of the networking stack. |
|
transport/queue
Package queue provides the implementation of buffer queue and interface of queue entry with Length method.
|
Package queue provides the implementation of buffer queue and interface of queue entry with Length method. |
|
transport/tcp
Package tcp contains the implementation of the TCP transport protocol.
|
Package tcp contains the implementation of the TCP transport protocol. |
|
transport/tcpconntrack
Package tcpconntrack implements a TCP connection tracking object.
|
Package tcpconntrack implements a TCP connection tracking object. |
|
transport/udp
Package udp contains the implementation of the UDP transport protocol.
|
Package udp contains the implementation of the UDP transport protocol. |
|
transport/unix
Package unix contains the implementation of Unix endpoints.
|
Package unix contains the implementation of Unix endpoints. |
|
Package tmutex provides the implementation of a mutex that implements an efficient TryLock function in addition to Lock and Unlock.
|
Package tmutex provides the implementation of a mutex that implements an efficient TryLock function in addition to Lock and Unlock. |
|
Package waiter provides the implementation of a wait queue, where waiters can be enqueued to be notified when an event of interest happens.
|
Package waiter provides the implementation of a wait queue, where waiters can be enqueued to be notified when an event of interest happens. |
Click to show internal directories.
Click to hide internal directories.