Received: from mx0b-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 04CFD170826 for ; Wed, 22 Jan 2025 06:17:03 +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=1737526625; cv=none; b=WMn//vV/U26z4hwbIhlOpCKBzDUrzO8FZL48KgFd1qx5H0UMF8H35lsrw46C4VsYKC68HYMKvzn6tzRlwv0anDW590EyIBY4Rsh8x1eLKgdeqF1jXvCXjY6yjOg0nA7Y3KavuvJ7gVYx3n/oDMrjrQQLO7z5MZj6fP7Lkt9y4dc= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1737526625; c=relaxed/simple; bh=DivZoeFokSxu7WKlQpB1JD5+6o/gyC/GEKM04SWnPQY=; h=From:To:CC:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=ivVWBgSa0ZZth9dNCjAITasq/p7f/ThBSbvCr85h5fpRFPPdWCFZq0fLUrSrxOTNoTDHcSrb8dIiwBwpRjl5HazopgnGDZmBvnFmX1u8q1Uk13ZqPiGDUzpYQPMjPjWky0eNTKwbO+YD+BUH/Vh8ItZ0zhMgDMn3S9ga5AT6fho= 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=gvOWuByN; 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="gvOWuByN" Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.18.1.2/8.18.1.2) with ESMTP id 50M4Xku4022678; Tue, 21 Jan 2025 22:16:57 -0800 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=7 1OBYvBj9rYb9tUaoWeL9BLAbgLbjaALJgH+bRKBb5Q=; b=gvOWuByNLfQqTh0m2 ZrzaK+HsCu3J/axX8tFDvawEmfHhUiCxo9a+AVjs2++vV57Im18S2+aisvQmDgIQ 0hXT0UzCqkQDdBeNMipBz7DGaoEtyw+L3n6xn4n4jqosB7HkiJRXwZeoseXPlPFW YT+2O12OphmZSb8nqMs5M107RKzpGwBWwspJDHiG7DXwwNWY5ZztuahV4kWJvViY IyU7tPXXKP9frz7QlqdcMRblwAZjAJU8DSXz0PkqbROe5SjY34dQeijYbaiV+iAz zqHwXzAbskxTCTlIDCOHsnzsDpKSa5IQKW221IO6ZUmXda3BTHZNoT4dqXRjvMBN 0oZFg== Received: from dc6wp-exch02.marvell.com ([4.21.29.225]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 44asrrr4v3-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 21 Jan 2025 22:16:56 -0800 (PST) Received: from DC6WP-EXCH02.marvell.com (10.76.176.209) by DC6WP-EXCH02.marvell.com (10.76.176.209) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Tue, 21 Jan 2025 22:16:55 -0800 Received: from maili.marvell.com (10.69.176.80) by DC6WP-EXCH02.marvell.com (10.76.176.209) with Microsoft SMTP Server id 15.2.1544.4 via Frontend Transport; Tue, 21 Jan 2025 22:16:55 -0800 Received: from localhost.localdomain (unknown [10.28.36.175]) by maili.marvell.com (Postfix) with ESMTP id 55E153F70B4; Tue, 21 Jan 2025 22:16:52 -0800 (PST) From: Srujana Challa To: CC: , , , , , , , , Subject: [PATCH RFC v3 2/4] virtio-crypto: Add resource objects for IPsec outbound and inbound SAs Date: Wed, 22 Jan 2025 11:46:42 +0530 Message-ID: <20250122061644.266560-3-schalla@marvell.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20250122061644.266560-1-schalla@marvell.com> References: <20250122061644.266560-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: _afeGyx6HbUJs3xLecbkzkFrcJU92_xR X-Proofpoint-ORIG-GUID: _afeGyx6HbUJs3xLecbkzkFrcJU92_xR X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.293,Aquarius:18.0.1057,Hydra:6.0.680,FMLib:17.12.68.34 definitions=2025-01-22_02,2025-01-22_01,2024-11-22_01 This commit introduces resource objects to enable the driver/device to create IPsec Security Associations (SAs) for both inbound and outbound directions. The IPsec SA objects include essential parameters required for packet outbound and inbound processing, such as SPI, tunnel headers, IPsec mode, IPsec options and cipher/authentication specific data. Signed-off-by: Srujana Challa --- device-types/crypto/description.tex | 145 ++++++++++++++++++++++++++++ 1 file changed, 145 insertions(+) diff --git a/device-types/crypto/description.tex b/device-types/crypto/description.tex index 2c00e50..0ba09df 100644 --- a/device-types/crypto/description.tex +++ b/device-types/crypto/description.tex @@ -336,6 +336,20 @@ \subsection{Device and driver capabilities}\label{sec:Device Types / Crypto Devi \hline \end{tabularx} +\subsection{Device resource objects}\label{sec:Device Types / Crypto Device / Device resource objects} + +The crypto device has the following resource objects. + +\begin{tabularx}{\textwidth}{ |l||l|X| } +\hline +type & Name & Description \\ +\hline \hline +0x0200 & \hyperref[par:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Resource objects / VIRTIO-CRYPTO-RESOURCE-OBJ-IPSEC-OUTBOUND-SA]{VIRTIO_CRYPTO_RESOURCE_OBJ_IPSEC_OUTBOUND_SA} & IPsec outbound SA resource object \\ +\hline +0x0201 & \hyperref[par:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Resource objects / VIRTIO-CRYPTO-RESOURCE-OBJ-IPSEC-INBOUND-SA]{VIRTIO_CRYPTO_RESOURCE_OBJ_IPSEC_INBOUND_SA} & IPsec inbound SA resource object \\ +\hline +\end{tabularx} + \subsection{Device Operation}\label{sec:Device Types / Crypto Device / Device Operation} The operation of a virtio crypto device is driven by requests placed on the virtqueues. @@ -2028,3 +2042,134 @@ \subsubsection{IPSEC Service Operation}\label{sec:Device Types / Crypto Device / \hline \end{tabularx} \end{table} + +\paragraph{Resource objects} +\label{par:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Resource objects} + +\subparagraph{VIRTIO_CRYPTO_RESOURCE_OBJ_IPSEC_OUTBOUND_SA}\label{par:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Resource objects / VIRTIO-CRYPTO-RESOURCE-OBJ-IPSEC-OUTBOUND-SA} + +A driver can have outbound SAs between 0 and \field{outb_sa_limit}, as specified by the +capability VIRTIO_CRYPTO_IPSEC_RESOURCE_CAP. For the IPsec outbound SA resource object +\field{resource_obj_specific_data} is in the format +\field{struct virtio_crypto_resource_obj_ipsec_sa}. + +\begin{lstlisting} +struct in_addr { + le32 s_addr; +}; + +struct in6_addr { + union { + u8 S6_u8[16]; + le32 S6_u32[4]; + le64 S6_u64[2]; + } S6_un; +}; + +struct virtio_crypto_ipsec_tunnel_param { + /* Tunnel type: IPv4 or IPv6 */ + u8 type; + u8 reserved[3]; + union { + /* IPv4 tunnel header parameters */ + struct { + /* IPv4 source address */ + struct in_addr src_ip; + /* IPv4 destination address */ + struct in_addr dst_ip; + /* IPv4 Differentiated Services Code Point */ + u8 dscp; + /* IPv4 Don't Fragment bit */ + u8 df; + /* IPv4 Time To Live */ + u8 ttl; + } ipv4; + /* IPv6 tunnel header parameters */ + struct { + /* IPv6 source address */ + struct in6_addr src_addr; + /* IPv6 destination address */ + struct in6_addr dst_addr; + /* IPv6 flow label */ + le32 flabel; + /* IPv6 hop limit */ + u8 hlimit; + /* IPv6 Differentiated Services Code Point */ + u8 dscp; + } ipv6; + }; +}; + +struct virtio_crypto_resource_obj_ipsec_sa { + le32 spi; + le32 salt; + le64 options; + struct virtio_crypto_ipsec_tunnel_param param; + le64 esn; + le16 udp_sport; + le16 udp_dport; + le32 replay_win_sz; + le64 cipher_algo; + struct { + le16 length; + u8 data[]; + } cipher_key; + le64 auth_algo; + struct { + le16 length; + u8 data[]; + } auth_key; + le32 obj_id; + u8 mode; + u8 direction; +} +\end{lstlisting} + +\field{spi} is the Security Parameter Index(SPI) used to uniquely identify the IPsec SA. +\field{salt} is the 32 bit salt value used in the cryptographic operations. + +\field{options} specifies the Options for configuring the IPsec SA, see +\ref{table:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Device and driver capabilities / VIRTIO-CRYPTO-IPSEC-SA-CAP / IPsec Options}. + +\field{param} specifies the parameters for IPsec tunnel mode. +\field{esn} is the starting sequence number. +\field{udp_sport} is the source port for UDP encapsulation. \field{udp_dport} is the +destination port for UDP encapsulation. +\field{replay_win_sz} is the anti-replay window size to enable sequence replay attack +handling, replay checking is disabled if the window size is 0. + +\field{cipher_algo} is the cipher algorithm identifier +see \ref{sec:Device Types / Crypto Device / Supported crypto services / CIPHER services} +\field{cipher_key} specifies the cipher key and its length. +\field{auth_algo} is the Authentication algorithm identifier +\field{auth_key} specifies the authentication key data and its length. +\field{obj_id} specifies the object id of the SA that can be used to retrieve +driver-defined data associated with the IPsec SA. + +\field{mode} specifies the mode of the IPsec SA, see +\ref{table:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Device and driver capabilities / VIRTIO-CRYPTO-IPSEC-SA-CAP / IPsec Modes}. + +\field{direction} specifies IPsec SA direction. + +\begin{table}[H] +\caption{IPsec Direction} +\label{table:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Device and driver capabilities / VIRTIO-CRYPTO-RESOURCE-OBJ-IPSEC-OUTBOUND-SA / IPsec Direction} +\begin{tabularx}{\textwidth}{ |l|X|X| } +\hline +Type & Name & Description \\ +\hline \hline +0x0 & - & Reserved \\ +\hline +0x1 & VIRTIO_CRYPTO_IPSEC_DIR_OUTBOUND & IPsec direction outbound \\ +\hline +0x2 & VIRTIO_CRYPTO_IPSEC_DIR_INBOUND & IPsec direction inbound \\ +\hline +\end{tabularx} +\end{table} + +\subparagraph{VIRTIO_CRYPTO_RESOURCE_OBJ_IPSEC_INBOUND_SA}\label{par:Device Types / Crypto Device / Device Operation / IPsec Service Operation / Resource objects / VIRTIO-CRYPTO-RESOURCE-OBJ-IPSEC-INBOUND-SA} + +A driver can have inbound SAs between 0 and \field{inb_sa_limit}, as specified by the +capability VIRTIO_CRYPTO_IPSEC_RESOURCE_CAP. For the IPsec inbound SA resource object +\field{resource_obj_specific_data} is in the format +\field{struct virtio_crypto_resource_obj_ipsec_sa}. -- 2.25.1