Received: from mx0a-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8253B210F5D for ; Tue, 29 Apr 2025 12:40:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=67.231.148.174 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1745930433; cv=none; b=bD653Vn/4PINIVBsjrwqIzVMMAkqkTMMeldtMR/9QjLF1hzgft7fbPnV3PPfCm2QTwFHRBBJCxLawox6jbNydpIjYygivKc0Pg79dKhISpqQO50bdz3icBnzvnvbzlG3kZWAZ36g8rhHaCdtTkNryiYwE6Nz7W2fj0ICrhSVezc= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1745930433; c=relaxed/simple; bh=T22sTD6XPRXWxnNxgg2yG52bQI3mVlSFd56LAYjPoIQ=; h=From:To:CC:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=N0o6oE4pgz+vbet6ORw8cLu0oHAxXnKnllw2YGXRvSF+BFxbLSA1n4zyoa/kUHK8iJmk26Le3cAUb8fXLui78vpAq1wnlJ7XV/OIjt3L+cFreBQ2vXsFkR3Cd0iYfTy9RbNh5s0dvmyLo6UK0yV1JiM03MJ8xbUvJShQVLolMa0= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=marvell.com; spf=pass smtp.mailfrom=marvell.com; dkim=pass (2048-bit key) header.d=marvell.com header.i=@marvell.com header.b=c+6t3ygb; arc=none smtp.client-ip=67.231.148.174 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=marvell.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=marvell.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=marvell.com header.i=@marvell.com header.b="c+6t3ygb" Received: from pps.filterd (m0431384.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.18.1.2/8.18.1.2) with ESMTP id 53T6cERu024861; Tue, 29 Apr 2025 05:40:30 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to; s=pfpt0220; bh=e bi8mmtKAW0U1/kKZHUIQrc8j9y2i5XRm1YWKqd8g5s=; b=c+6t3ygbU4DZo84+l lqF7qOPtw9o8++qcp2+6cmdu2r5Kj+nAa12oDhdPMkauFI/CWsb3TtO+NwYf4WUu duURMSD+fJySFabOhmylupAN9vZ02Bx9ool6movAWcVwp+F1QyW2hbRojX0707c8 pAF6R51LnSwxTcxaybQfadNjVym4pGKv02Q7W9iE0UoQXswxB5n3ZI3oHzO/gQix fvy7JF7VXkMaKOb4RdsIUnM9b5MVEYwCQVl3x37Lmx07N5KJgx/Yyp/CKqQC/6Wv gnqm70TXdZXGNpw9e2PzjSi4HBD1c8tyeYFI3iZrlJvBSR/jrBt0TdLGB2fQpmH8 3EA3g== Received: from dc5-exch05.marvell.com ([199.233.59.128]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 469krccfse-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 29 Apr 2025 05:40:30 -0700 (PDT) Received: from DC5-EXCH05.marvell.com (10.69.176.209) by DC5-EXCH05.marvell.com (10.69.176.209) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Tue, 29 Apr 2025 05:40:29 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH05.marvell.com (10.69.176.209) with Microsoft SMTP Server id 15.2.1544.4 via Frontend Transport; Tue, 29 Apr 2025 05:40:29 -0700 Received: from localhost.localdomain (unknown [10.28.36.175]) by maili.marvell.com (Postfix) with ESMTP id 579AE5B6949; Tue, 29 Apr 2025 05:40:26 -0700 (PDT) From: Srujana Challa To: CC: , , , , , , , , Subject: [PATCH RFC v6 4/4] virtio-net: Add IPsec operation device and driver requirements Date: Tue, 29 Apr 2025 18:10:10 +0530 Message-ID: <20250429124010.1949371-5-schalla@marvell.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20250429124010.1949371-1-schalla@marvell.com> References: <20250429124010.1949371-1-schalla@marvell.com> Precedence: bulk X-Mailing-List: virtio-comment@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-GUID: TovrO80skgeDNpjU9KTa8PZgbNQUpJVW X-Authority-Analysis: v=2.4 cv=f61IBPyM c=1 sm=1 tr=0 ts=6810c8be cx=c_pps a=rEv8fa4AjpPjGxpoe8rlIQ==:117 a=rEv8fa4AjpPjGxpoe8rlIQ==:17 a=XR8D0OoHHMoA:10 a=M5GUcnROAAAA:8 a=Ikd4Dj_1AAAA:8 a=QX9oew5WznxAzni0h4MA:9 a=OBjm3rFKGHvpk9ecZwUJ:22 X-Proofpoint-Spam-Details-Enc: AW1haW4tMjUwNDI5MDA5NCBTYWx0ZWRfXx/YGDZO0QA/3 2qAbUzQKqGR0MQN2Y8zFKxJ0Pa/hXghEvI0xNASafzj4tocMx9oi6l0z7j0o2Hjdv/W9yXvPzPQ SINzcKWQ6FzrlK+B9Ps3jcRrp2sz2SLcUdY54YXwayY2RhYEPKsKbd8Dy9Z3/a7BrXrivY43Oi1 m1vZ3vZxIsTJZKr3bpDizBGk/NFGaPiHWx84W4uOJcUinYVJlnZFJtP4eq/lD/wuayUFBWtJA/i Mw6NI4ZKcGzPOyOYdpO/g0DTTVxJXXPE7KtXpRyKcSDcXskWSNhOyiiUc3YQCb3IoJZ/YjVYFyO 2tL4pEl8P4NYFYcVLQZMBob6Sr4Hh307U8kDByAAUI/Xuittvrj3UezgDrx46+u7bm4N7EUtfjH ayCiWGv8VU/rkM0atPkzX/lMUq5NaMnAwY7rPh5yaWH4wHzx+0GA25iADLwyoUOxfzBI8G81 X-Proofpoint-ORIG-GUID: TovrO80skgeDNpjU9KTa8PZgbNQUpJVW X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1099,Hydra:6.0.736,FMLib:17.12.80.40 definitions=2025-04-29_04,2025-04-24_02,2025-02-21_01 Add device and driver requirements for IPsec Operation. Signed-off-by: Srujana Challa Reviewed-by: Parav Pandit --- device-types/net/description.tex | 83 +++++++++++++++++++++++++ device-types/net/device-conformance.tex | 1 + device-types/net/driver-conformance.tex | 1 + 3 files changed, 85 insertions(+) diff --git a/device-types/net/description.tex b/device-types/net/description.tex index 2540f2b..36b2a80 100644 --- a/device-types/net/description.tex +++ b/device-types/net/description.tex @@ -3596,6 +3596,89 @@ \subsubsection{IPsec Operation}\label{sec:Device Types / Network Device / Device See \hyperref[par:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Resource objects / VIRTIO-CRYPTO-RESOURCE-OBJ-IPSEC-INBOUND-SA]{VIRTIO_NET_RESOURCE_OBJ_IPSEC_INB_SA}. +\devicenormative{\paragraph}{IPsec Operation}{Device Types / Net Device / Device Operation / IPsec Operation} + +When the device supports IPsec operations, +\begin{itemize} +\item the device MUST set VIRTIO_NET_IPSEC_RESOURCE_CAP, VIRTIO_NET_IPSEC_SA_CAP +capability in the \field{supported_caps} in the command VIRTIO_ADMIN_CMD_CAP_SUPPORT_QUERY. +\item the device MUST support the administration commands +VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE, +VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY, VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY, +VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY for the resource types +VIRTIO_NET_RESOURCE_OBJ_IPSEC_OUTB_SA and VIRTIO_NET_RESOURCE_OBJ_IPSEC_INB_SA. +\end{itemize} + +When any of the VIRTIO_NET_IPSEC_RESOURCE_CAP or VIRTIO_NET_IPSEC_SA_CAP +capability is disabled, the device MUST set \field{status} to +VIRTIO_ADMIN_STATUS_Q_INVALID_OPCODE for the commands +VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE, +VIRTIO_ADMIN_CMD_RESOURCE_OBJ_MODIFY, VIRTIO_ADMIN_CMD_RESOURCE_OBJ_QUERY, +and VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY for the resource types +VIRTIO_NET_RESOURCE_OBJ_IPSEC_OUTB_SA and VIRTIO_NET_RESOURCE_OBJ_IPSEC_INB_SA. + +The device MUST set \field{status} to VIRTIO_ADMIN_STATUS_EEXIT for the +command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE when the resource \field{type} +is VIRTIO_NET_RESOURCE_OBJ_IPSEC_OUTB_SA or VIRTIO_NET_RESOURCE_OBJ_IPSEC_INB_SA, +if the object already exists with the supplied \field{id}. + +The device MUST fail the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE for the +VIRTIO_NET_RESOURCE_OBJ_IPSEC_OUTB_SA object if, +\begin{itemize} +\item \field{id} is greater than or equal to \field{outb_sa_limit}. +\item the supplied SA parameters, such as mode, options, cipher and authentication + algorithms are not supported in the capabitlity VIRTIO_NET_IPSEC_SA_CAP. +\end{itemize} + +The device MUST fail the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE for the +VIRTIO_NET_RESOURCE_OBJ_IPSEC_INB_SA object if, +\begin{itemize} +\item \field{id} is greater than or equal to \field{inb_sa_limit}. +\item the supplied SA parameters, such as mode, options, cipher and authentication + algorithms are not supported in the capabitlity VIRTIO_NET_IPSEC_SA_CAP. +\end{itemize} + +The device SHOULD maintain a table for subsequent lookups to inbound/outbound data +with the corresponding SA based on the supplied \field{id}. + +The device MUST allow recreating the resource objects using the command +VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE which was previously destroyed using +the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_DESTROY respectively without +undergoing a device reset. + +The device MAY fail the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE with +the \field{status} set to VIRTIO_ADMIN_STATUS_EINVAL for the +VIRTIO_CRYPTO_RESOURCE_OBJ_IPSEC_OUTB_SA or VIRTIO_CRYPTO_RESOURCE_OBJ_IPSEC_INB_SA +commands if the resource object with the same \field{spi} already exists. + +On device reset, the device MUST destroy all the resource objects which have been created. + +\drivernormative{\paragraph}{IPsec Operation}{Device Types / Net Device / Device Operation / IPsec Operation} + +The driver MUST query the capabilities using VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY +to discover the capability types the device offers. + +The driver MUST get VIRTIO_NET_IPSEC_RESOURCE_CAP and VIRTIO_NET_IPSEC_SA_CAP +if listed in VIRTIO_ADMIN_CMD_CAP_ID_LIST_QUERY command result, using +VIRTION_ADMIN_CMD_DEVICE_CAP_GET to discover the capabilities the device is +able to offer. +The driver MUST set VIRTIO_NET_IPSEC_RESOURCE_CAP and VIRTIO_NET_IPSEC_SA_CAP +using VIRTIO_ADMIN_CMD_DEVICE_CAP_SET to indicate the device which capability +the driver uses. + +For the command VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE, when creating a resource +VIRTIO_NET_RESOURCE_OBJ_IPSEC_OUTB_SA, the driver MUST set all the parameters +in \field{struct virtio_crypto_resource_obj_ipsec_sa} with relevant values. +And when create a resource object VIRTIO_NET_RESOURCE_OBJ_IPSEC_INB_SA, +the driver MUST set all the parameters except +\field{struct virtio_crypto_ipsec_tunnel_param}. + +The driver SHOULD NOT add multiple inbound SA objects with the same \field{spi}. + +In the outbound data path, the driver MUST ensure that packets do +not exceed the PMTU prior to transmission to the device. +(Refer to \hyperref[intro:IPSEC]{[IPSEC]} for a detailed description of PMTU) + \subsubsection{Legacy Interface: Framing Requirements}\label{sec:Device Types / Network Device / Legacy Interface: Framing Requirements} diff --git a/device-types/net/device-conformance.tex b/device-types/net/device-conformance.tex index d88484c..7fe8505 100644 --- a/device-types/net/device-conformance.tex +++ b/device-types/net/device-conformance.tex @@ -18,4 +18,5 @@ \item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / Device Statistics} \item \ref{devicenormative:Device Types / Network Device / Device Operation / Control Virtqueue / RSS Context} \item \ref{devicenormative:Device Types / Network Device / Device Operation / Flow filter} +\item \ref{devicenormative:Device Types / Network Device / Device Operation / IPsec Operation} \end{itemize} diff --git a/device-types/net/driver-conformance.tex b/device-types/net/driver-conformance.tex index d346b88..0d20190 100644 --- a/device-types/net/driver-conformance.tex +++ b/device-types/net/driver-conformance.tex @@ -18,4 +18,5 @@ \item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / Device Statistics} \item \ref{drivernormative:Device Types / Network Device / Device Operation / Control Virtqueue / RSS Context} \item \ref{drivernormative:Device Types / Network Device / Device Operation / Flow filter} +\item \ref{drivernormative:Device Types / Network Device / Device Operation / IPsec Operation} \end{itemize} -- 2.25.1