From patchwork Mon Jan 13 09:31:20 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonio Quartulli X-Patchwork-Id: 13937037 X-Patchwork-Delegate: kuba@kernel.org Received: from mail-wr1-f44.google.com (mail-wr1-f44.google.com [209.85.221.44]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1695B23A587 for ; Mon, 13 Jan 2025 09:31:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.44 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736760669; cv=none; b=e5CxmE/J4P6w54wy0FI4DM0A0clEwgjhnwCECgCBlTvbSL0KV/3sEXdh00D34TwNRHp2oWgdG3IdAqIZAGO718ugKe7R7br8bH3LZ2+Mv1kyxal7aCe17vJQX0/xF0e1Nuh5tora3YtwmZhv8IJkwndtxH/ueYqTpLgM+yu0/kc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1736760669; c=relaxed/simple; bh=edgMw6UOefVG4P8ZYkS+jJr+3yK/hLi8k4NGzEbCjSo=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:References: In-Reply-To:To:Cc; b=QnjFQcCLnJV4ohAM7VMX9MjfiQsBrMi85f/rav/QJ83cZxtFZtNHYSgM4xvxoBUCGmMONZjA1xG+5LYUkQi7uZ9EhbOzCeqfF13okSkGxM2/1vtjoeTOapvgRLSXQm/h27jaLv5RkPEeHrxXinMP0MjWZERiLAl4cIHtQq4AME0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=openvpn.net; spf=pass smtp.mailfrom=openvpn.com; dkim=pass (2048-bit key) header.d=openvpn.net header.i=@openvpn.net header.b=TyQnZsC2; arc=none smtp.client-ip=209.85.221.44 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=openvpn.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=openvpn.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=openvpn.net header.i=@openvpn.net header.b="TyQnZsC2" Received: by mail-wr1-f44.google.com with SMTP id ffacd0b85a97d-38a8b35e168so2453345f8f.1 for ; Mon, 13 Jan 2025 01:31:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=openvpn.net; s=google; t=1736760664; x=1737365464; darn=vger.kernel.org; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:from:to:cc:subject:date:message-id :reply-to; bh=iI7ZSU5DXweIEDOaDNGZszzfDqW/+KycGHum5JWfNqw=; b=TyQnZsC2z5HD6gY6JV8ghDIvPyCwSUSKWF/hCJm1bO4uj+0nuuXLNmdqoKnc85hedY Qt7tJXTXxWVR6xOeGCbznO74oerEZxwku5tHNfMDmE+HecCilOl37JPwhb/YTtZkCRcG K+jq06IN0FVfoHm/Jn1JV+4DrXuYIpIFj8/0o5miglFl3EV0BmlIQcoNLIzvYd/09WRX 5P/nffN2f81bnOetV8rMAn/KqwEPI9fOWX+qXyr1N5d+uLlbiGN26r3eNRXCzYhzwZeW u/ArtLsGdgkrq4ISRSKLRWMWKIQ6BkOI3R+ndFagc84sdHU44j11Kiu8Y0ONB7Je76T7 VKhA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736760664; x=1737365464; h=cc:to:in-reply-to:references:message-id:content-transfer-encoding :mime-version:subject:date:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=iI7ZSU5DXweIEDOaDNGZszzfDqW/+KycGHum5JWfNqw=; b=B01P59ZfInNYiZgP63NLDOdHp4heccXr2TWJKA1qdnAYXg4KPBITTSIfkesCx5J5WW hvR/cmb7KDgw632NlDU69+RpeN+aOGB3egVLccSSeRMsxtiSWjWQL/M/TPAsQ2u0tmf5 zIONFX71uSM7iN5OGF8BjxaeMnZ69V06oOXKyJN8Gzr6H2YCK1U+1B/zjpXwepyvBR65 iog121z3VZaXSCRfkUxYBzONKaqso5GyXCKsr6SWPDINgym6/H3KS72UuplnbZDWtDZg 4Awwxu3lGpFeKNlOM51n8qAngVXdQ2Q9VOh75BkWXsx9GdPex6dQNCAex/tAeLDSAvFr u1hQ== X-Gm-Message-State: AOJu0YxNmAlgMtl2gLvSAf6qFUyPqBy86VgmwVC0nW8zW/2sY2XOpnf2 0/EaKoreY5jzkI+i43O3LhVAopHLndHLSH3eWlOwNkYzncp9+Sd6VKzRxIYi1FA= X-Gm-Gg: ASbGnctLvo/fkK7/S3eKBTgY2G37hxAW8cpm5BN98TzAXQVYVhu85C9F0NkGDPbTg1T 7P/eMmp0L3Qn2qF9XJh8+DuEUAcM7MSC7a9ekSdMTRm0FL4WmpA5FkkmbMopCWw1p+BJcO7CgXO UDhUEN9qP+BaLKugRqLv0O2x04MJ9AgL6y1cxmrI8ghULzjlXlZHI7xvw7o2d7sjngHHdjNNdaJ ZdcrkMeqG8Hi2ca65yIOhLrohbKWPvjjozVbXF+Jp7c10AxmbKH2W8EG7wD1n2TuhZX X-Google-Smtp-Source: AGHT+IHKZTefZEp1E4PrbT0k2DFRGvHhd2wYPBLhR5aDt25I+ErGY3jl/GNox9GRl+3Qg1YFVHLM/Q== X-Received: by 2002:adf:9d89:0:b0:38a:906e:16d0 with SMTP id ffacd0b85a97d-38a906e1826mr9016034f8f.21.1736760664300; Mon, 13 Jan 2025 01:31:04 -0800 (PST) Received: from serenity.mandelbit.com ([2001:67c:2fbc:1:8305:bf37:3bbd:ed1d]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-38a8e4b8124sm11528446f8f.81.2025.01.13.01.31.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 13 Jan 2025 01:31:03 -0800 (PST) From: Antonio Quartulli Date: Mon, 13 Jan 2025 10:31:20 +0100 Subject: [PATCH net-next v18 01/25] net: introduce OpenVPN Data Channel Offload (ovpn) Precedence: bulk X-Mailing-List: netdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-Id: <20250113-b4-ovpn-v18-1-1f00db9c2bd6@openvpn.net> References: <20250113-b4-ovpn-v18-0-1f00db9c2bd6@openvpn.net> In-Reply-To: <20250113-b4-ovpn-v18-0-1f00db9c2bd6@openvpn.net> To: netdev@vger.kernel.org, Eric Dumazet , Jakub Kicinski , Paolo Abeni , Donald Hunter , Antonio Quartulli , Shuah Khan , sd@queasysnail.net, ryazanov.s.a@gmail.com, Andrew Lunn Cc: Simon Horman , linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, Xiao Liang , steffen.klassert@secunet.com, antony.antony@secunet.com X-Mailer: b4 0.14.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=8929; i=antonio@openvpn.net; h=from:subject:message-id; bh=edgMw6UOefVG4P8ZYkS+jJr+3yK/hLi8k4NGzEbCjSo=; b=owEBbQGS/pANAwAIAQtw5TqgONWHAcsmYgBnhN2Flw/t+dj2c9Kz0KRuxoblS+gy1OgLbLSW6 QVZFgAHmyqJATMEAAEIAB0WIQSZq9xs+NQS5N5fwPwLcOU6oDjVhwUCZ4TdhQAKCRALcOU6oDjV hwl5CACaIZ3dORLpCEJZKzi+lr5H04dtow5z7GZjqtIOULhutJ/R0SiQ1bG17uYejXBhCBL2g8Y sKysIB2NNEHZjiDXlZtPwZ79rIrLVV/11k1KOYwMh2bpHd1DA1kSKeT9nuvbAQVmdo0z201MGY0 6O9ChhcVrTIyCkJTYVdiw5PiYAqvcHyMJLu8mzlsaupnkbAFTwhgmJM6CrlmH52DNn+aKPUocd1 UsYYdf0CJFhs6B4Wf0qxR8T4P4YWR4Nx241TINLVjMI0n9foichlWpW2FaOwJe1PBZzpFga5cHL cPGFuTWkHwWKlsd5HcCRTq2FGKN56Sii64sKBTsnSUrYug7h X-Developer-Key: i=antonio@openvpn.net; a=openpgp; fpr=CABDA1282017C267219885C748F0CCB68F59D14C X-Patchwork-Delegate: kuba@kernel.org OpenVPN is a userspace software existing since around 2005 that allows users to create secure tunnels. So far OpenVPN has implemented all operations in userspace, which implies several back and forth between kernel and user land in order to process packets (encapsulate/decapsulate, encrypt/decrypt, rerouting..). With `ovpn` we intend to move the fast path (data channel) entirely in kernel space and thus improve user measured throughput over the tunnel. `ovpn` is implemented as a simple virtual network device driver, that can be manipulated by means of the standard RTNL APIs. A device of kind `ovpn` allows only IPv4/6 traffic and can be of type: * P2P (peer-to-peer): any packet sent over the interface will be encapsulated and transmitted to the other side (typical OpenVPN client or peer-to-peer behaviour); * P2MP (point-to-multipoint): packets sent over the interface are transmitted to peers based on existing routes (typical OpenVPN server behaviour). After the interface has been created, OpenVPN in userspace can configure it using a new Netlink API. Specifically it is possible to manage peers and their keys. The OpenVPN control channel is multiplexed over the same transport socket by means of OP codes. Anything that is not DATA_V2 (OpenVPN OP code for data traffic) is sent to userspace and handled there. This way the `ovpn` codebase is kept as compact as possible while focusing on handling data traffic only (fast path). Any OpenVPN control feature (like cipher negotiation, TLS handshake, rekeying, etc.) is still fully handled by the userspace process. When userspace establishes a new connection with a peer, it first performs the handshake and then passes the socket to the `ovpn` kernel module, which takes ownership. From this moment on `ovpn` will handle data traffic for the new peer. When control packets are received on the link, they are forwarded to userspace through the same transport socket they were received on, as userspace is still listening to them. Some events (like peer deletion) are sent to a Netlink multicast group. Although it wasn't easy to convince the community, `ovpn` implements only a limited number of the data-channel features supported by the userspace program. Each feature that made it to `ovpn` was attentively vetted to avoid carrying too much legacy along with us (and to give a clear cut to old and probalby-not-so-useful features). Notably, only encryption using AEAD ciphers (specifically ChaCha20Poly1305 and AES-GCM) was implemented. Supporting any other cipher out there was not deemed useful. Both UDP and TCP sockets are supported. As explained above, in case of P2MP mode, OpenVPN will use the main system routing table to decide which packet goes to which peer. This implies that no routing table was re-implemented in the `ovpn` kernel module. This kernel module can be enabled by selecting the CONFIG_OVPN entry in the networking drivers section. NOTE: this first patch introduces the very basic framework only. Features are then added patch by patch, however, although each patch will compile and possibly not break at runtime, only after having applied the full set it is expected to see the ovpn module fully working. Cc: steffen.klassert@secunet.com Cc: antony.antony@secunet.com Signed-off-by: Antonio Quartulli --- MAINTAINERS | 8 ++++ drivers/net/Kconfig | 8 ++++ drivers/net/Makefile | 1 + drivers/net/ovpn/Makefile | 10 +++++ drivers/net/ovpn/main.c | 112 ++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 139 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 797e94ba74f75b68f6c8bc7ff699179baec02650..f71c8a4492ad83221a619d211612716d815b3a5b 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -17557,6 +17557,14 @@ F: arch/openrisc/ F: drivers/irqchip/irq-ompic.c F: drivers/irqchip/irq-or1k-* +OPENVPN DATA CHANNEL OFFLOAD +M: Antonio Quartulli +L: openvpn-devel@lists.sourceforge.net (subscribers-only) +L: netdev@vger.kernel.org +S: Supported +T: git https://github.com/OpenVPN/linux-kernel-ovpn.git +F: drivers/net/ovpn/ + OPENVSWITCH M: Pravin B Shelar L: netdev@vger.kernel.org diff --git a/drivers/net/Kconfig b/drivers/net/Kconfig index 1fd5acdc73c6af0e1a861867039c3624fc618e25..2ace5e27c37ed3bad2e0000775cd172cb6de3225 100644 --- a/drivers/net/Kconfig +++ b/drivers/net/Kconfig @@ -115,6 +115,14 @@ config WIREGUARD_DEBUG Say N here unless you know what you're doing. +config OVPN + tristate "OpenVPN data channel offload" + depends on NET && INET + depends on IPV6 || !IPV6 + help + This module enhances the performance of the OpenVPN userspace software + by offloading the data channel processing to kernelspace. + config EQUALIZER tristate "EQL (serial line load balancing) support" help diff --git a/drivers/net/Makefile b/drivers/net/Makefile index 13743d0e83b5fde479e9b30ad736be402d880dee..5152b3330e28da7eaec821018a26c973bb33ce0c 100644 --- a/drivers/net/Makefile +++ b/drivers/net/Makefile @@ -11,6 +11,7 @@ obj-$(CONFIG_IPVLAN) += ipvlan/ obj-$(CONFIG_IPVTAP) += ipvlan/ obj-$(CONFIG_DUMMY) += dummy.o obj-$(CONFIG_WIREGUARD) += wireguard/ +obj-$(CONFIG_OVPN) += ovpn/ obj-$(CONFIG_EQUALIZER) += eql.o obj-$(CONFIG_IFB) += ifb.o obj-$(CONFIG_MACSEC) += macsec.o diff --git a/drivers/net/ovpn/Makefile b/drivers/net/ovpn/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..ae19cf445b29367da680e226f06a341c42c892c2 --- /dev/null +++ b/drivers/net/ovpn/Makefile @@ -0,0 +1,10 @@ +# SPDX-License-Identifier: GPL-2.0 +# +# ovpn -- OpenVPN data channel offload in kernel space +# +# Copyright (C) 2020-2024 OpenVPN, Inc. +# +# Author: Antonio Quartulli + +obj-$(CONFIG_OVPN) := ovpn.o +ovpn-y += main.o diff --git a/drivers/net/ovpn/main.c b/drivers/net/ovpn/main.c new file mode 100644 index 0000000000000000000000000000000000000000..72c56e73771cdece22e50645b29c79962f06caf3 --- /dev/null +++ b/drivers/net/ovpn/main.c @@ -0,0 +1,112 @@ +// SPDX-License-Identifier: GPL-2.0 +/* OpenVPN data channel offload + * + * Copyright (C) 2020-2024 OpenVPN, Inc. + * + * Author: Antonio Quartulli + * James Yonan + */ + +#include +#include +#include + +static const struct net_device_ops ovpn_netdev_ops = { +}; + +/** + * ovpn_dev_is_valid - check if the netdevice is of type 'ovpn' + * @dev: the interface to check + * + * Return: whether the netdevice is of type 'ovpn' + */ +static bool ovpn_dev_is_valid(const struct net_device *dev) +{ + return dev->netdev_ops == &ovpn_netdev_ops; +} + +static int ovpn_newlink(struct net *src_net, struct net_device *dev, + struct nlattr *tb[], struct nlattr *data[], + struct netlink_ext_ack *extack) +{ + return -EOPNOTSUPP; +} + +static struct rtnl_link_ops ovpn_link_ops = { + .kind = "ovpn", + .netns_refund = false, + .newlink = ovpn_newlink, + .dellink = unregister_netdevice_queue, +}; + +static int ovpn_netdev_notifier_call(struct notifier_block *nb, + unsigned long state, void *ptr) +{ + struct net_device *dev = netdev_notifier_info_to_dev(ptr); + + if (!ovpn_dev_is_valid(dev)) + return NOTIFY_DONE; + + switch (state) { + case NETDEV_REGISTER: + /* add device to internal list for later destruction upon + * unregistration + */ + break; + case NETDEV_UNREGISTER: + /* can be delivered multiple times, so check registered flag, + * then destroy the interface + */ + break; + case NETDEV_POST_INIT: + case NETDEV_GOING_DOWN: + case NETDEV_DOWN: + case NETDEV_UP: + case NETDEV_PRE_UP: + default: + return NOTIFY_DONE; + } + + return NOTIFY_OK; +} + +static struct notifier_block ovpn_netdev_notifier = { + .notifier_call = ovpn_netdev_notifier_call, +}; + +static int __init ovpn_init(void) +{ + int err = register_netdevice_notifier(&ovpn_netdev_notifier); + + if (err) { + pr_err("ovpn: can't register netdevice notifier: %d\n", err); + return err; + } + + err = rtnl_link_register(&ovpn_link_ops); + if (err) { + pr_err("ovpn: can't register rtnl link ops: %d\n", err); + goto unreg_netdev; + } + + return 0; + +unreg_netdev: + unregister_netdevice_notifier(&ovpn_netdev_notifier); + return err; +} + +static __exit void ovpn_cleanup(void) +{ + rtnl_link_unregister(&ovpn_link_ops); + unregister_netdevice_notifier(&ovpn_netdev_notifier); + + rcu_barrier(); +} + +module_init(ovpn_init); +module_exit(ovpn_cleanup); + +MODULE_DESCRIPTION("OpenVPN data channel offload (ovpn)"); +MODULE_AUTHOR("(C) 2020-2024 OpenVPN, Inc."); +MODULE_LICENSE("GPL");