net: WireGuard secure network tunnel
WireGuard is a layer 3 secure networking tunnel made specifically for the kernel, that aims to be much simpler and easier to audit than IPsec. Extensive documentation and description of the protocol and considerations, along with formal proofs of the cryptography, are available at: * https://www.wireguard.com/ * https://www.wireguard.com/papers/wireguard.pdf This commit implements WireGuard as a simple network device driver, accessible in the usual RTNL way used by virtual network drivers. It makes use of the udp_tunnel APIs, GRO, GSO, NAPI, and the usual set of networking subsystem APIs. It has a somewhat novel multicore queueing system designed for maximum throughput and minimal latency of encryption operations, but it is implemented modestly using workqueues and NAPI. Configuration is done via generic Netlink, and following a review from the Netlink maintainer a year ago, several high profile userspace tools have already implemented the API. This commit also comes with several different tests, both in-kernel tests and out-of-kernel tests based on network namespaces, taking profit of the fact that sockets used by WireGuard intentionally stay in the namespace the WireGuard interface was originally created, exactly like the semantics of userspace tun devices. See wireguard.com/netns/ for pictures and examples. The source code is fairly short, but rather than combining everything into a single file, WireGuard is developed as cleanly separable files, making auditing and comprehension easier. Things are laid out as follows: * noise.[ch], cookie.[ch], messages.h: These implement the bulk of the cryptographic aspects of the protocol, and are mostly data-only in nature, taking in buffers of bytes and spitting out buffers of bytes. They also handle reference counting for their various shared pieces of data, like keys and key lists. * ratelimiter.[ch]: Used as an integral part of cookie.[ch] for ratelimiting certain types of cryptographic operations in accordance with particular WireGuard semantics. * allowedips.[ch], peerlookup.[ch]: The main lookup structures of WireGuard, the former being trie-like with particular semantics, an integral part of the design of the protocol, and the latter just being nice helper functions around the various hashtables we use. * device.[ch]: Implementation of functions for the netdevice and for rtnl, responsible for maintaining the life of a given interface and wiring it up to the rest of WireGuard. * peer.[ch]: Each interface has a list of peers, with helper functions available here for creation, destruction, and reference counting. * socket.[ch]: Implementation of functions related to udp_socket and the general set of kernel socket APIs, for sending and receiving ciphertext UDP packets, and taking care of WireGuard-specific sticky socket routing semantics for the automatic roaming. * netlink.[ch]: Userspace API entry point for configuring WireGuard peers and devices. The API has been implemented by several userspace tools and network management utility, and the WireGuard project distributes the basic wg(8) tool. * queueing.[ch]: Shared function on the rx and tx path for handling the various queues used in the multicore algorithms. * send.c: Handles encrypting outgoing packets in parallel on multiple cores, before sending them in order on a single core, via workqueues and ring buffers. Also handles sending handshake and cookie messages as part of the protocol, in parallel. * receive.c: Handles decrypting incoming packets in parallel on multiple cores, before passing them off in order to be ingested via the rest of the networking subsystem with GRO via the typical NAPI poll function. Also handles receiving handshake and cookie messages as part of the protocol, in parallel. * timers.[ch]: Uses the timer wheel to implement protocol particular event timeouts, and gives a set of very simple event-driven entry point functions for callers. * main.c, version.h: Initialization and deinitialization of the module. * selftest/*.h: Runtime unit tests for some of the most security sensitive functions. * tools/testing/selftests/wireguard/netns.sh: Aforementioned testing script using network namespaces. This commit aims to be as self-contained as possible, implementing WireGuard as a standalone module not needing much special handling or coordination from the network subsystem. I expect for future optimizations to the network stack to positively improve WireGuard, and vice-versa, but for the time being, this exists as intentionally standalone. We introduce a menu option for CONFIG_WIREGUARD, as well as providing a verbose debug log and self-tests via CONFIG_WIREGUARD_DEBUG. Signed-off-by:Jason A. Donenfeld <Jason@zx2c4.com> Cc: David Miller <davem@davemloft.net> Cc: Greg KH <gregkh@linuxfoundation.org> Cc: Linus Torvalds <torvalds@linux-foundation.org> Cc: Herbert Xu <herbert@gondor.apana.org.au> Cc: linux-crypto@vger.kernel.org Cc: linux-kernel@vger.kernel.org Cc: netdev@vger.kernel.org Signed-off-by:
David S. Miller <davem@davemloft.net>
-
mentioned in commit 0ffd4563
-
mentioned in commit 52c05fea
-
mentioned in commit df364086
-
mentioned in commit c8bd0fd5
-
mentioned in commit 70f7dd2a
-
mentioned in commit c7b1307f
-
mentioned in commit 2a3b3899
-
mentioned in commit 71717fb2
-
mentioned in commit 2e4f5385
-
mentioned in commit d64fdbae
-
mentioned in commit f74da2c2
-
mentioned in commit b8d72ac1
-
mentioned in commit 842c21d6
-
mentioned in commit 42a66771
-
mentioned in commit c5155c74
-
mentioned in commit 70a9a71a
-
mentioned in commit df3b45f6
-
mentioned in commit 8af215cc
-
mentioned in commit 3709c87e
-
mentioned in commit 4b8aa955
-
mentioned in commit 8eee870d
-
mentioned in commit 90b33dbb
-
mentioned in commit 6f425fc6
-
mentioned in commit af04157d
-
mentioned in commit 5ceb59f4
-
mentioned in commit fb32f4f6
-
mentioned in commit 886fcee9
-
mentioned in commit 4e3fd721
-
mentioned in commit cb2d7c19
-
mentioned in commit 8a29a50d
-
mentioned in commit 1c75779d
-
mentioned in commit 77fc73ac
-
mentioned in commit bbbf962d
-
mentioned in commit 49f77ab5
-
mentioned in commit 096f9d35
-
mentioned in commit 402991a9
-
mentioned in commit 9af42a4f
-
mentioned in commit efde4c0c
-
mentioned in commit ebcc492f
-
mentioned in commit 41d6ac68
-
mentioned in commit 37a04788
-
mentioned in commit 26c01310
-
mentioned in commit 684dec3c
-
mentioned in commit f0a057f4
-
mentioned in commit b7b38595
-
mentioned in commit c60801e4
-
mentioned in commit 3ebf690d
-
mentioned in commit 92f7d44d
-
mentioned in commit 3b263cc1
-
mentioned in commit 3173bfdf
-
mentioned in commit 561aaadf
-
mentioned in commit 9a131762
-
mentioned in commit 35a11857
-
mentioned in commit 46622219
-
mentioned in commit 890ac460
-
mentioned in commit 3f00757a
-
mentioned in commit be41c0c4
-
mentioned in commit 4206f46d
-
mentioned in commit b605d23c