While functional and tested to some extent, this project is still in early development phase: don't use in production or critical environments yet. # passt: Plug A Simple Socket Transport _passt_ implements a translation layer between a Layer-2 network interface and native Layer-4 sockets (TCP, UDP, ICMP/ICMPv6 echo) on a host. It doesn't require any capabilities or privileges, and it can be used as a simple replacement for Slirp. # pasta: Pack A Subtle Tap Abstraction _pasta_ (same binary as _passt_, different command) offers equivalent functionality, for network namespaces: traffic is forwarded using a tap interface inside the namespace, without the need to create further interfaces on the host, hence not requiring any capabilities or privileges. It also implements a tap bypass path for local connections: packets with a local destination address are moved directly between Layer-4 sockets, avoiding Layer-2 translations, using the _splice_(2) and _recvmmsg_(2)/_sendmmsg_(2) system calls for TCP and UDP, respectively. - [Motivation](#motivation) - [Features](#features) - [Interfaces and Environment](#interfaces-and-environment) - [Services](#services) - [Addresses](#addresses) - [Protocols](#protocols) - [Ports](#ports) - [Demo](#demo) - [Continuous Integration](#continuous-integration) - [Performance](#performance_1) - [Try it](#try-it) - [Contribute](#contribute) - [Security and Vulnerability Reports](#security-and-vulnerability-reports) See also the [man page](/builds/latest/web/passt.1.html). ## Motivation ### passt When container workloads are moved to virtual machines, the network traffic is typically forwarded by interfaces operating at data link level. Some components in the containers ecosystem (such as _service meshes_), however, expect applications to run locally, with visible sockets and processes, for the purposes of socket redirection, monitoring, port mapping. To solve this issue, user mode networking, as provided e.g. by _libslirp_, can be used. Existing solutions implement a full TCP/IP stack, replaying traffic on sockets that are local to the pod of the service mesh. This creates the illusion of application processes running on the same host, eventually separated by user namespaces. While being almost transparent to the service mesh infrastructure, that kind of solution comes with a number of downsides: * three different TCP/IP stacks (guest, adaptation and host) need to be traversed for every service request * addressing needs to be coordinated to create the pretense of consistent addresses and routes between guest and host environments. This typically needs a NAT with masquerading, or some form of packet bridging * the traffic seen by the service mesh and observable externally is a distant replica of the packets forwarded to and from the guest environment: * TCP congestion windows and network buffering mechanisms in general operate differently from what would be naturally expected by the application * protocols carrying addressing information might pose additional challenges, as the applications don't see the same set of addresses and routes as they would if deployed with regular containers _passt_ implements a thinner layer between guest and host, that only implements what's strictly needed to pretend processes are running locally. The TCP adaptation doesn't keep per-connection packet buffers, and reflects observed sending windows and acknowledgements between the two sides. This TCP adaptation is needed as _passt_ runs without the `CAP_NET_RAW` capability: it can't create raw IP sockets on the pod, and therefore needs to map packets at Layer-2 to Layer-4 sockets offered by the host kernel. The problem and this approach are illustrated in more detail, with diagrams, [here](https://gitlab.com/abologna/kubevirt-and-kvm/-/blob/master/Networking.md). ### pasta On Linux, regular users can create network namespaces and run application services inside them. However, connecting namespaces to other namespaces and to external hosts requires the creation of network interfaces, such as `veth` pairs, which needs in turn elevated privileges or the `CAP_NET_ADMIN` capability. _pasta_, similarly to _slirp4netns_, solves this problem by creating a tap interface available to processes in the namespace, and mapping network traffic outside the namespace using native Layer-4 sockets. Existing approaches typically implement a full, generic TCP/IP stack for this translation between data and transport layers, without the possibility of speeding up local connections, and usually requiring NAT. _pasta_: * avoids the need for a generic, full-fledged TCP/IP stack by coordinating TCP connection dynamics between sender and receiver * offers a fast bypass path for local connections: if a process connects to another process on the same host across namespaces, data is directly forwarded using pairs of Layer-4 sockets * with default options, maps routing and addressing information to the namespace, avoiding any need for NAT ## Features ### Protocols * ✅ IPv4 * ✅ all features, except for * ❌ fragmentation * ✅ IPv6 * ✅ all features, except for * ❌ fragmentation * ❌ jumbograms * ✅ [TCP](/passt/tree/tcp.c) * ✅ Window Scaling (RFC 7323) * ✅ Defenses against Sequence Number Attacks (RFC 6528) * ⌚ [Protection Against Wrapped Sequences](https://bugs.passt.top/show_bug.cgi?id=1) (PAWS, RFC 7323) * ⌚ [Timestamps](https://bugs.passt.top/show_bug.cgi?id=1) (RFC 7323) * ❌ Selective Acknowledgment (RFC 2018) * ✅ [UDP](/passt/tree/udp.c) * ✅ ICMP/ICMPv6 Echo * ⌚ [IGMP/MLD](https://bugs.passt.top/show_bug.cgi?id=2) proxy * ⌚ [SCTP](https://bugs.passt.top/show_bug.cgi?id=3) ### Portability * Linux * ✅ starting from 4.18 kernel version * ✅ starting from 3.13 kernel version * 🛠 build-time selection of AVX2 instructions (as much as possible) * ⌚ [_musl_](https://bugs.passt.top/show_bug.cgi?id=4) and [_uClibc-ng_](https://bugs.passt.top/show_bug.cgi?id=5) * ⌚ [FreeBSD](https://bugs.passt.top/show_bug.cgi?id=6), [Darwin](https://bugs.passt.top/show_bug.cgi?id=6) * ⌚ [NetBSD](https://bugs.passt.top/show_bug.cgi?id=7), [OpenBSD](https://bugs.passt.top/show_bug.cgi?id=7) * ⌚ [Win2k](https://bugs.passt.top/show_bug.cgi?id=8) ### Security * ✅ no dynamic memory allocation (`sbrk`(2), `brk`(2), `mmap`(2) [blocked via `seccomp`](/passt/tree/seccomp.sh)) * ✅ root operation not allowed outside user namespaces * ✅ all capabilities dropped, other than `CAP_NET_BIND_SERVICE` (if granted) * ✅ with default options, user, mount, IPC, UTS, PID namespaces are detached * ✅ no external dependencies (other than a standard C library) * ✅ restrictive seccomp profiles (22 syscalls allowed for _passt_, 34 for _pasta_ on x86_64) * ✅ static checkers in continuous integration (clang-tidy, cppcheck) * 🛠️ rework of TCP state machine (flags instead of states), TCP timers, and code de-duplication * 🛠️ clearly defined packet abstraction * 🛠️ ~5 000 LoC target * ⌚ [fuzzing](https://bugs.passt.top/show_bug.cgi?id=9), _packetdrill_ tests * ⌚ stricter [synflood protection](https://bugs.passt.top/show_bug.cgi?id=10) * 💡 [your](https://lists.passt.top/) [ideas](https://bugs.passt.top/) [here](https://chat.passt.top) ### Configurability * ✅ all addresses, ports, port ranges * ✅ optional NAT, not required * ✅ all protocols * ✅ _pasta_: auto-detection of bound ports * 🛠 run-time configuration of port ranges without autodetection * 🛠 configuration of port ranges for autodetection * 💡 [your](https://lists.passt.top/) [ideas](https://bugs.passt.top/) [here](https://chat.passt.top) ### Performance * ✅ maximum two (cache hot) copies on every data path * ✅ _pasta_: zero-copy for local connections by design (no configuration needed) * ✅ generalised coalescing and batching on every path for every supported protocol * ✅ 4 to 50 times IPv4 TCP throughput of existing, conceptually similar solutions depending on MTU (UDP and IPv6 hard to compare) * 🛠 _vhost-user_ support for maximum one copy on every data path and lower request-response latency * ⌚ [multithreading](https://bugs.passt.top/show_bug.cgi?id=13) * ⌚ [raw IP socket support](https://bugs.passt.top/show_bug.cgi?id=14) if `CAP_NET_RAW` is granted * ⌚ eBPF support (might not improve performance over vhost-user) ### Interfaces * ✅ qemu, libvirt support with [`qrap` wrapper](/passt/tree/qrap.c) * ✅ out-of-tree patches for [qemu](/passt/tree/qemu) and [libvirt](/passt/tree/libvirt) available * 🛠 bug-to-bug compatible [_slirp4netns_ replacement](/passt/tree/slirp4netns.sh) (rootless Podman, RootlessKit) * 🛠 native [qemu](https://bugs.passt.top/show_bug.cgi?id=11), [libvirt](https://bugs.passt.top/show_bug.cgi?id=12) support * ⌚ drop-in replacement for VPNKit (rootless Docker) ### Availability * ✅ convenience unofficial packages for Debian, RPM-based distributions on x86_64 (static builds) * ✅ testing on non-x86 architectures * 🛠 official [OpenSUSE packages](https://build.opensuse.org/package/show/home:mnhauke/passt) * ⌚ packages for Debian, Fedora, etc. ### Services * ✅ built-in [ARP proxy](/passt/tree/arp.c) * ✅ minimalistic [DHCP server](/passt/tree/dhcp.c) * ✅ minimalistic [NDP proxy](/passt/tree/ndp.c) with router advertisements and SLAAC support * ✅ minimalistic [DHCPv6 server](/passt/tree/dhcpv6.c) * ⌚ fine-grained configurability of DHCP, NDP, DHCPv6 options ## Interfaces and Environment _passt_ exchanges packets with _qemu_ via UNIX domain socket, using the `socket` back-end in qemu. Currently, qemu can only connect to a listening process via TCP. Two temporary solutions are available: * a [patch](/passt/tree/qemu) for qemu * a wrapper, [qrap](/passt/tree/qrap.c), that connects to a UNIX domain socket and starts qemu, which can now use the file descriptor that's already opened This approach, compared to using a _tap_ device, doesn't require any security capabilities, as we don't need to create any interface. _pasta_ runs out of the box with any recent (post-3.8) Linux kernel. ## Services _passt_ and _pasta_ provide some minimalistic implementations of networking services: * [ARP proxy](/passt/tree/arp.c), that resolves the address of the host (which is used as gateway) to the original MAC address of the host * [DHCP server](/passt/tree/dhcp.c), a simple implementation handing out one single IPv4 address to the guest or namespace, namely, the same address as the first one configured for the upstream host interface, and passing the nameservers configured on the host * [NDP proxy](/passt/tree/ndp.c), which can also assign prefix and nameserver using SLAAC * [DHCPv6 server](/passt/tree/dhcpv6.c): a simple implementation handing out one single IPv6 address to the guest or namespace, namely, the the same address as the first one configured for the upstream host interface, and passing the nameservers configured on the host ## Addresses For IPv4, the guest or namespace is assigned, via DHCP, the same address as the upstream interface of the host, and the same default gateway as the default gateway of the host. Addresses are translated in case the guest is seen using a different address from the assigned one. For IPv6, the guest or namespace is assigned, via SLAAC, the same prefix as the upstream interface of the host, the same default route as the default route of the host, and, if a DHCPv6 client is running in the guest or namespace, also the same address as the upstream address of the host. This means that, with a DHCPv6 client in the guest or namespace, addresses don't need to be translated. Should the client use a different address, the destination address is translated for packets going to the guest or to the namespace. ### Local connections with _passt_ For UDP and TCP, for both IPv4 and IPv6, packets from the host addressed to a loopback address are forwarded to the guest with their source address changed to the address of the gateway or first hop of the default route. This mapping is reversed on the other way. ### Local connections with _pasta_ Packets addressed to a loopback address in either namespace are directly forwarded to the corresponding (or configured) port in the other namespace. Similarly as _passt_, packets from the non-init namespace addressed to the default gateway, which are therefore sent via the tap device, will have their destination address translated to the loopback address. ## Protocols _passt_ and _pasta_ support TCP, UDP and ICMP/ICMPv6 echo (requests and replies). More details about the TCP implementation are available [here](/passt/tree/tcp.c), and for the UDP implementation [here](/passt/tree/udp.c). An IGMP/MLD proxy is currently work in progress. ## Ports ### passt To avoid the need for explicit port mapping configuration, _passt_ can bind to all unbound non-ephemeral (0-49152) TCP and UDP ports. Binding to low ports (0-1023) will fail without additional capabilities, and ports already bound (service proxies, etc.) will also not be used. Smaller subsets of ports, with port translations, are also configurable. UDP ephemeral ports are bound dynamically, as the guest uses them. If all ports are forwarded, service proxies and other services running in the container need to be started before _passt_ starts. ### pasta With default options, _pasta_ scans for bound ports on init and non-init namespaces, and automatically forwards them from the other side. Port forwarding is fully configurable with command line options. ## Demo ### pasta
use pasta to create and connect a namespace
use Podman with pasta
### passt
## Continuous Integration
Test logs [here](/builds/latest/test/). ## Performance ## Try it ### passt * build from source: git clone https://passt.top/passt cd passt make * alternatively, static builds for x86_64, with or without AVX2 instructions, as of the latest commit are also available for convenience [here](/builds/latest/x86_64/avx2/) and [here](/builds/latest/x86_64/). Convenience, non-official packages for Debian (and derivatives) and RPM-based distributions are also available there. These binaries and packages are simply built with: CFLAGS="-static" make avx2 make pkgs make static make pkgs * have a look at the _man_ page for synopsis and options: man ./passt.1 * run the demo script, that creates a network namespace called `passt`, sets up sets up a _veth_ pair and and addresses, together with NAT for IPv4 and NDP proxying for IPv6, then starts _passt_ in the network namespace: doc/demo.sh * from the same network namespace, start qemu. At the moment, qemu doesn't support UNIX domain sockets for the `socket` back-end. Two alternatives: * use the _qrap_ wrapper, which maps a tap socket descriptor to _passt_'s UNIX domain socket, for example: ip netns exec passt ./qrap 5 qemu-system-x86_64 ... -net socket,fd=5 -net nic,model=virtio ... * or patch qemu with [this patch](/passt/tree/qemu/0001-net-Allow-also-UNIX-domain-sockets-to-be-used-as-net.patch) and start it like this: qemu-system-x86_64 ... -net socket,connect=/tmp/passt.socket -net nic,model=virtio * alternatively, you can use libvirt, with [this patch](/passt/tree/libvirt/0001-conf-Introduce-support-for-UNIX-domain-socket-as-qem.patch), to start qemu (with the patch mentioned above), with this kind of network interface configuration:
* and that's it, you should now have TCP connections, UDP, and ICMP/ICMPv6 echo working from/to the guest for IPv4 and IPv6 * to connect to a service on the VM, just connect to the same port directly with the address of the network namespace. For example, to ssh to the guest, from the main namespace on the host: ssh 192.0.2.2 ### pasta * build from source: git clone https://passt.top/passt cd passt make * alternatively, static builds for x86_64, with or without AVX2 instructions, as of the latest commit are also available for convenience [here](/builds/latest/x86_64/avx2/) and [here](/builds/latest/x86_64/). Convenience, non-official packages for Debian (and derivatives) and RPM-based distributions are also available there. These binaries and packages are simply built with: CFLAGS="-static" make avx2 make pkgs make static make pkgs * have a look at the _man_ page for synopsis and options: man ./pasta.1 * start pasta with: ./pasta * you're now inside a new user and network namespace. For IPv6, SLAAC happens right away as _pasta_ sets up the interface, but DHCPv6 support is available as well. For IPv4, configure the interface with a DHCP client: dhclient and, optionally: dhclient -6 * and that's it, you should now have TCP connections, UDP, and ICMP/ICMPv6 echo working from/to the guest for IPv4 and IPv6 * to connect to a service inside the namespace, just connect to the same port using the loopback address. ## Contribute ### [Mailing Lists](/passt/lists) * Submit, review patches, and discuss development ideas on [`passt-dev`](https://lists.passt.top/postorius/lists/passt-dev.passt.top/) * Ask your questions and discuss usage needs on [`passt-user`](https://lists.passt.top/postorius/lists/passt-user.passt.top/) ### [Bug Reports and Feature Requests](/passt/bugs) * [File a bug](https://bugs.passt.top/enter_bug.cgi) for those ### [Chat](/passt/chat) * Somebody might be available on [IRC](https://irc.passt.top) ## Security and Vulnerability Reports * Please send an email to [passt-sec](mailto:passt-sec@passt.top), private list, no subscription required