From nobody Fri May 3 02:59:38 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1503734257310324.54516837263145; Sat, 26 Aug 2017 00:57:37 -0700 (PDT) Received: from localhost ([::1]:56458 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dlVyJ-0000eh-Ue for importer@patchew.org; Sat, 26 Aug 2017 03:57:35 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33539) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dlVwt-0008UR-LF for qemu-devel@nongnu.org; Sat, 26 Aug 2017 03:56:13 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dlVwn-0006Lr-Ir for qemu-devel@nongnu.org; Sat, 26 Aug 2017 03:56:07 -0400 Received: from szxga04-in.huawei.com ([45.249.212.190]:2304) by eggs.gnu.org with esmtps (TLS1.0:RSA_ARCFOUR_SHA1:16) (Exim 4.71) (envelope-from ) id 1dlVwl-0006Ix-Ls for qemu-devel@nongnu.org; Sat, 26 Aug 2017 03:56:01 -0400 Received: from 172.30.72.59 (EHLO DGGEMS410-HUB.china.huawei.com) ([172.30.72.59]) by dggrg04-dlp.huawei.com (MOS 4.4.6-GA FastPath queued) with ESMTP id DFX65776; Sat, 26 Aug 2017 15:55:23 +0800 (CST) Received: from localhost (10.177.246.209) by DGGEMS410-HUB.china.huawei.com (10.3.19.210) with Microsoft SMTP Server id 14.3.301.0; Sat, 26 Aug 2017 15:55:14 +0800 From: "Longpeng(Mike)" To: , Date: Sat, 26 Aug 2017 15:53:33 +0800 Message-ID: <1503734014-239116-2-git-send-email-longpeng2@huawei.com> X-Mailer: git-send-email 1.8.4.msysgit.0 In-Reply-To: <1503734014-239116-1-git-send-email-longpeng2@huawei.com> References: <1503734014-239116-1-git-send-email-longpeng2@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.177.246.209] X-CFilter-Loop: Reflected X-Mirapoint-Virus-RAPID-Raw: score=unknown(0), refid=str=0001.0A090206.59A1296D.0042, ss=1, re=0.000, recu=0.000, reip=0.000, cl=1, cld=1, fgs=0, ip=0.0.0.0, so=2014-11-16 11:51:01, dmn=2013-03-21 17:37:32 X-Mirapoint-Loop-Id: a55d01d7bcc134283e4a4af615ed53cd X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] [fuzzy] X-Received-From: 45.249.212.190 Subject: [Qemu-devel] [PATCH v19 1/2] virtio-crypto: Add virtio crypto device specification X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: weidong.huang@huawei.com, mst@redhat.com, jasowang@redhat.com, john.griffin@intel.com, Varun.Sethi@freescale.com, denglingli@chinamobile.com, arei.gonglei@hotmail.com, agraf@suse.de, Gonglei , nmorey@kalray.eu, "Longpeng\(Mike\)" , vincent.jardin@6wind.com, Ola.Liljedahl@arm.com, luonengjun@huawei.com, xin.zeng@intel.com, liang.j.ma@intel.com, stefanha@redhat.com, Jani.Kokkonen@huawei.com, pasic@linux.vnet.ibm.com, brian.a.keating@intel.com, wangxinxin.wang@huawei.com, cohuck@redhat.com, mike.caraman@nxp.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Gonglei The virtio crypto device is a virtual crypto device (ie. hardware crypto accelerator card). Currently, the virtio crypto device provides the following crypto services: CIPHER, MAC, HASH, and AEAD. In this patch, CIPHER, MAC, HASH, AEAD services are introduced. VIRTIO-153 Signed-off-by: Gonglei Signed-off-by: Longpeng(Mike) --- acknowledgements.tex | 3 + content.tex | 2 + virtio-crypto.tex | 1479 ++++++++++++++++++++++++++++++++++++++++++++++= ++++ 3 files changed, 1484 insertions(+) create mode 100644 virtio-crypto.tex diff --git a/acknowledgements.tex b/acknowledgements.tex index 6c86d12..c4b6844 100644 --- a/acknowledgements.tex +++ b/acknowledgements.tex @@ -26,6 +26,8 @@ Sasha Levin, Oracle \newline Sergey Tverdyshev, Thales e-Security \newline Stefan Hajnoczi, Red Hat \newline Tom Lyon, Samya Systems, Inc. \newline +Lei Gong, Huawei \newline +Peng Long, Huawei \newline \end{oasistitlesection} =20 The following non-members have provided valuable feedback on this @@ -43,4 +45,5 @@ Laura Novich, Red Hat \newline Patrick Durusau, Technical Advisory Board, OASIS \newline Thomas Huth, IBM \newline Yan Vugenfirer, Red Hat / Daynix \newline +Halil Pasic, IBM \newline \end{oasistitlesection} diff --git a/content.tex b/content.tex index d989d98..7710f8c 100644 --- a/content.tex +++ b/content.tex @@ -5641,6 +5641,8 @@ descriptor for the \field{sense_len}, \field{residual= }, \field{status_qualifier}, \field{status}, \field{response} and \field{sense} fields. =20 +\input{virtio-crypto.tex} + \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits} =20 Currently there are three device-independent feature bits defined: diff --git a/virtio-crypto.tex b/virtio-crypto.tex new file mode 100644 index 0000000..1e75cbc --- /dev/null +++ b/virtio-crypto.tex @@ -0,0 +1,1479 @@ +\section{Crypto Device}\label{sec:Device Types / Crypto Device} + +The virtio crypto device is a virtual cryptography device as well as a +virtual cryptographic accelerator. The virtio crypto device provides the +following crypto services: CIPHER, MAC, HASH, and AEAD. Virtio crypto +devices have a single control queue and at least one data queue. Crypto +operation requests are placed into a data queue, and serviced by the +device. Some crypto operation requests are only valid in the context of a +session. The role of the control queue is facilitating control operation +requests. Sessions management is realized with control operation +requests. + +\subsection{Device ID}\label{sec:Device Types / Crypto Device / Device ID} + +20 + +\subsection{Virtqueues}\label{sec:Device Types / Crypto Device / Virtqueue= s} + +\begin{description} +\item[0] dataq1 +\item[\ldots] +\item[N-1] dataqN +\item[N] controlq +\end{description} + +N is set by \field{max_dataqueues}. + +\subsection{Feature bits}\label{sec:Device Types / Crypto Device / Feature= bits} + +\begin{description} +\item VIRTIO_CRYPTO_F_MUX_MODE (0) multiplexing mode is available. +\item VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE (1) stateless mode is availabl= e for CIPHER service. +\item VIRTIO_CRYPTO_F_HASH_STATELESS_MODE (2) stateless mode is available = for HASH service. +\item VIRTIO_CRYPTO_F_MAC_STATELESS_MODE (3) stateless mode is available f= or MAC service. +\item VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE (4) stateless mode is available = for AEAD service. +\end{description} + +\subsubsection{Feature bit requirements}\label{sec:Device Types / Crypto D= evice / Feature bits} + +Some crypto feature bits require other crypto feature bits +(see \ref{drivernormative:Basic Facilities of a Virtio Device / Feature Bi= ts}): + +\begin{description} +\item[VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_= MODE. +\item[VIRTIO_CRYPTO_F_HASH_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MO= DE. +\item[VIRTIO_CRYPTO_F_MAC_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MOD= E. +\item[VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE] Requires VIRTIO_CRYPTO_F_MUX_MO= DE. +\end{description} + +\subsection{Supported crypto services}\label{sec:Device Types / Crypto Dev= ice / Supported crypto services} + +The following crypto services are defined: + +\begin{lstlisting} +/* CIPHER service */ +#define VIRTIO_CRYPTO_SERVICE_CIPHER 0 +/* HASH service */ +#define VIRTIO_CRYPTO_SERVICE_HASH 1 +/* MAC (Message Authentication Codes) service */ +#define VIRTIO_CRYPTO_SERVICE_MAC 2 +/* AEAD (Authenticated Encryption with Associated Data) service */ +#define VIRTIO_CRYPTO_SERVICE_AEAD 3 +\end{lstlisting} + +The above constants designate bits used to indicate the which of crypto se= rvices are +offered by the device as described in, see \ref{sec:Device Types / Crypto = Device / Device configuration layout}. + +\subsubsection{CIPHER services}\label{sec:Device Types / Crypto Device / S= upported crypto services / CIPHER services} + +The following CIPHER algorithms are defined: + +\begin{lstlisting} +#define VIRTIO_CRYPTO_NO_CIPHER 0 +#define VIRTIO_CRYPTO_CIPHER_ARC4 1 +#define VIRTIO_CRYPTO_CIPHER_AES_ECB 2 +#define VIRTIO_CRYPTO_CIPHER_AES_CBC 3 +#define VIRTIO_CRYPTO_CIPHER_AES_CTR 4 +#define VIRTIO_CRYPTO_CIPHER_DES_ECB 5 +#define VIRTIO_CRYPTO_CIPHER_DES_CBC 6 +#define VIRTIO_CRYPTO_CIPHER_3DES_ECB 7 +#define VIRTIO_CRYPTO_CIPHER_3DES_CBC 8 +#define VIRTIO_CRYPTO_CIPHER_3DES_CTR 9 +#define VIRTIO_CRYPTO_CIPHER_KASUMI_F8 10 +#define VIRTIO_CRYPTO_CIPHER_SNOW3G_UEA2 11 +#define VIRTIO_CRYPTO_CIPHER_AES_F8 12 +#define VIRTIO_CRYPTO_CIPHER_AES_XTS 13 +#define VIRTIO_CRYPTO_CIPHER_ZUC_EEA3 14 +\end{lstlisting} + +The above constants have two usages: +\begin{enumerate} +\item As bit numbers, used to tell the driver which CIPHER algorithms +are supported by the device, see \ref{sec:Device Types / Crypto Device / D= evice configuration layout}. +\item As values, used to tell the device which CIPHER algorithm +a crypto request from the driver requires, see \ref{sec:Device Types / Cry= pto Device / Device Operation / Control Virtqueue / Session operation}. +\end{enumerate} + +\subsubsection{HASH services}\label{sec:Device Types / Crypto Device / Sup= ported crypto services / HASH services} + +The following HASH algorithms are defined: + +\begin{lstlisting} +#define VIRTIO_CRYPTO_NO_HASH 0 +#define VIRTIO_CRYPTO_HASH_MD5 1 +#define VIRTIO_CRYPTO_HASH_SHA1 2 +#define VIRTIO_CRYPTO_HASH_SHA_224 3 +#define VIRTIO_CRYPTO_HASH_SHA_256 4 +#define VIRTIO_CRYPTO_HASH_SHA_384 5 +#define VIRTIO_CRYPTO_HASH_SHA_512 6 +#define VIRTIO_CRYPTO_HASH_SHA3_224 7 +#define VIRTIO_CRYPTO_HASH_SHA3_256 8 +#define VIRTIO_CRYPTO_HASH_SHA3_384 9 +#define VIRTIO_CRYPTO_HASH_SHA3_512 10 +#define VIRTIO_CRYPTO_HASH_SHA3_SHAKE128 11 +#define VIRTIO_CRYPTO_HASH_SHA3_SHAKE256 12 +\end{lstlisting} + +The above constants have two usages: +\begin{enumerate} +\item As bit numbers, used to tell the driver which HASH algorithms +are supported by the device, see \ref{sec:Device Types / Crypto Device / D= evice configuration layout}. +\item As values, used to tell the device which HASH algorithm +a crypto request from the driver requires, see \ref{sec:Device Types / Cry= pto Device / Device Operation / Control Virtqueue / Session operation}. +\end{enumerate} + +\subsubsection{MAC services}\label{sec:Device Types / Crypto Device / Supp= orted crypto services / MAC services} + +The following MAC algorithms are defined: + +\begin{lstlisting} +#define VIRTIO_CRYPTO_NO_MAC 0 +#define VIRTIO_CRYPTO_MAC_HMAC_MD5 1 +#define VIRTIO_CRYPTO_MAC_HMAC_SHA1 2 +#define VIRTIO_CRYPTO_MAC_HMAC_SHA_224 3 +#define VIRTIO_CRYPTO_MAC_HMAC_SHA_256 4 +#define VIRTIO_CRYPTO_MAC_HMAC_SHA_384 5 +#define VIRTIO_CRYPTO_MAC_HMAC_SHA_512 6 +#define VIRTIO_CRYPTO_MAC_CMAC_3DES 25 +#define VIRTIO_CRYPTO_MAC_CMAC_AES 26 +#define VIRTIO_CRYPTO_MAC_KASUMI_F9 27 +#define VIRTIO_CRYPTO_MAC_SNOW3G_UIA2 28 +#define VIRTIO_CRYPTO_MAC_GMAC_AES 41 +#define VIRTIO_CRYPTO_MAC_GMAC_TWOFISH 42 +#define VIRTIO_CRYPTO_MAC_CBCMAC_AES 49 +#define VIRTIO_CRYPTO_MAC_CBCMAC_KASUMI_F9 50 +#define VIRTIO_CRYPTO_MAC_XCBC_AES 53 +#define VIRTIO_CRYPTO_MAC_ZUC_EIA3 54 +\end{lstlisting} + +The above constants have two usages: +\begin{enumerate} +\item As bit numbers, used to tell the driver which MAC algorithms +are supported by the device, see \ref{sec:Device Types / Crypto Device / D= evice configuration layout}. +\item As values, used to tell the device which MAC algorithm +a crypto request from the driver requires, see \ref{sec:Device Types / Cry= pto Device / Device Operation / Control Virtqueue / Session operation}. +\end{enumerate} + +\subsubsection{AEAD services}\label{sec:Device Types / Crypto Device / Sup= ported crypto services / AEAD services} + +The following AEAD algorithms are defined: + +\begin{lstlisting} +#define VIRTIO_CRYPTO_NO_AEAD 0 +#define VIRTIO_CRYPTO_AEAD_GCM 1 +#define VIRTIO_CRYPTO_AEAD_CCM 2 +#define VIRTIO_CRYPTO_AEAD_CHACHA20_POLY1305 3 +\end{lstlisting} + +The above constants have two usages: +\begin{enumerate} +\item As bit numbers, used to tell the driver which AEAD algorithms +are supported by the device, see \ref{sec:Device Types / Crypto Device / D= evice configuration layout}. +\item As values, used to tell the device what AEAD algorithm +a crypto request from the driver requires, see \ref{sec:Device Types / Cry= pto Device / Device Operation / Control Virtqueue / Session operation}. +\end{enumerate} + +\subsection{Device configuration layout}\label{sec:Device Types / Crypto D= evice / Device configuration layout} + +\begin{lstlisting} +struct virtio_crypto_config { + le32 status; + le32 max_dataqueues; + le32 crypto_services; + /* Detailed algorithms mask */ + le32 cipher_algo_l; + le32 cipher_algo_h; + le32 hash_algo; + le32 mac_algo_l; + le32 mac_algo_h; + le32 aead_algo; + /* Maximum length of cipher key in bytes */ + le32 max_cipher_key_len; + /* Maximum length of authenticated key in bytes */ + le32 max_auth_key_len; + le32 reserved; + /* Maximum size of each crypto request's content in bytes */ + le64 max_size; +}; +\end{lstlisting} + +\begin{description} +\item[\field{status}] is used to show whether the device is ready to work = or + not, it can be either zero or have one or more flags. Only one read-on= ly + bit (for the driver) is currently defined for the \field{status} field: V= IRTIO_CRYPTO_S_HW_READY: +\begin{lstlisting} +#define VIRTIO_CRYPTO_S_HW_READY (1 << 0) +\end{lstlisting} + +\item[\field{max_dataqueues}] is the maximum number of data virtqueues exp= osed by + the device. The driver MAY use only one data queue, + or it can use more to achieve better performance. + +\item[\field{crypto_services}] crypto service offered, see \ref{sec:Device= Types / Crypto Device / Supported crypto services}. + +\item[\field{cipher_algo_l}] CIPHER algorithms bits 0-31, see \ref{sec:Dev= ice Types / Crypto Device / Supported crypto services / CIPHER services}. + +\item[\field{cipher_algo_h}] CIPHER algorithms bits 32-63, see \ref{sec:De= vice Types / Crypto Device / Supported crypto services / CIPHER services}. + +\item[\field{hash_algo}] HASH algorithms bits, see \ref{sec:Device Types /= Crypto Device / Supported crypto services / HASH services}. + +\item[\field{mac_algo_l}] MAC algorithms bits 0-31, see \ref{sec:Device Ty= pes / Crypto Device / Supported crypto services / MAC services}. + +\item[\field{mac_algo_h}] MAC algorithms bits 32-63, see \ref{sec:Device T= ypes / Crypto Device / Supported crypto services / MAC services}. + +\item[\field{aead_algo}] AEAD algorithms bits, see \ref{sec:Device Types /= Crypto Device / Supported crypto services / AEAD services}. + +\item[\field{max_cipher_key_len}] is the maximum length of cipher key supp= orted by the device. + +\item[\field{max_auth_key_len}] is the maximum length of authenticated key= supported by the device. + +\item[\field{reserved}] is reserved for future use. + +\item[\field{max_size}] is the maximum size of each crypto request's conte= nt supported by the device +\end{description} + +\begin{note} +Unless explicitly stated otherwise all lengths and sizes are in bytes. +\end{note} + +\devicenormative{\subsubsection}{Device configuration layout}{Device Types= / Crypto Device / Device configuration layout} + +\begin{itemize*} +\item The device MUST set \field{max_dataqueues} to between 1 and 65535 in= clusive. +\item The device MUST set the \field{status} flag based on the status of t= he crypto + accelerator, Non-valid flags MUST NOT be set. +\item The device MUST accept and handle requests after \field{status} is s= et to VIRTIO_CRYPTO_S_HW_READY. +\item The device MUST set \field{crypto_services} based on the crypto serv= ices the device offers. +\item The device MUST set detailed algorithms masks for each service adver= tised by \field{crypto_services}. + The device MUST NOT set the not defined algorithms bits. +\item The device MUST set \field{max_size} to show the maximum size of cry= pto request the device supports. +\item The device MUST set \field{max_cipher_key_len} to show the maximum l= ength of cipher key if the + device supports CIPHER service. +\item The device MUST set \field{max_auth_key_len} to show the maximum len= gth of authenticated key if + the device supports MAC service. +\end{itemize*} + +\drivernormative{\subsubsection}{Device configuration layout}{Device Types= / Crypto Device / Device configuration layout} + +\begin{itemize*} +\item The driver MUST read the ready \field{status} from the bottom bit of= status to check whether the + crypto accelerator is ready or not, and the driver MUST reread it afte= r device reset. +\item The driver MUST NOT transmit any requests to the device if the ready= \field{status} is not set. +\item The driver MUST read \field{max_dataqueues} field to discover the nu= mber of data queues the device supports. +\item The driver MUST read \field{crypto_services} field to discover which= services the device is able to offer. +\item The driver SHOULD ignore the not defined algorithms bits. +\item The driver MUST read the detailed algorithms fields based on \field{= crypto_services} field. +\item The driver SHOULD read \field{max_size} to discover the maximum size= of crypto request the device supports. +\item The driver SHOULD read \field{max_cipher_key_len} to discover the ma= ximum length of cipher key + the device supports. +\item The driver SHOULD read \field{max_auth_key_len} to discover the maxi= mum length of authenticated + key the device supports. +\end{itemize*} + +\subsection{Device Initialization}\label{sec:Device Types / Crypto Device = / Device Initialization} + +\drivernormative{\subsubsection}{Device Initialization}{Device Types / Cry= pto Device / Device Initialization} + +\begin{itemize*} +\item The driver MUST identify and initialize all virtqueues. +\item The driver MUST read the supported crypto services from bits of \fie= ld{crypto_services}. +\item The driver MUST read the supported algorithms based on \field{crypto= _services} field. +\end{itemize*} + +\subsection{Device Operation}\label{sec:Device Types / Crypto Device / Dev= ice Operation} + +Requests can be transmitted by placing them in the controlq or dataq. +Requests consist of a queue-type specific header specifying among +others the operation, and an operation specific payload. +The payload is generally composed of operation parameters, output data, an= d input data. +Operation parameters are algorithm-specific parameters, output data is the +data that should be utilized in operations, and input data is equal to +"operation result + result data". + +The device can support both session mode (See \ref{sec:Device Types / Cryp= to Device / Device Operation / Control Virtqueue / Session operation}) and = stateless mode. +In stateless mode all operation parameters are supplied as a part +of each request, while in session mode, some or all operation parameters +are managed within the session. Stateless mode is guarded by +feature bits 0-4 on a service level. If stateless mode is negotiated +for a service, the service is available both in session and +stateless mode; otherwise it's only available in session mode. + +The device can set the operation status as follows: + +\begin{lstlisting} +enum VIRTIO_CRYPTO_STATUS { + VIRTIO_CRYPTO_OK =3D 0, + VIRTIO_CRYPTO_ERR =3D 1, + VIRTIO_CRYPTO_BADMSG =3D 2, + VIRTIO_CRYPTO_NOTSUPP =3D 3, + VIRTIO_CRYPTO_INVSESS =3D 4, + VIRTIO_CRYPTO_NOSPC =3D 5, + VIRTIO_CRYPTO_MAX +}; +\end{lstlisting} + +\begin{itemize*} +\item VIRTIO_CRYPTO_OK: success. +\item VIRTIO_CRYPTO_BADMSG: authentication failed (only when AEAD decrypti= on). +\item VIRTIO_CRYPTO_NOTSUPP: operation or algorithm is unsupported. +\item VIRTIO_CRYPTO_INVSESS: invalid session ID when executing crypto oper= ations. +\item VIRTIO_CRYPTO_NOSPC: no free session ID (only when the VIRTIO_CRYPTO= _F_MUX_MODE + feature bit is negotiated). +\item VIRTIO_CRYPTO_ERR: any failure not mentioned above occurs. +\end{itemize*} + +\subsubsection{Control Virtqueue}\label{sec:Device Types / Crypto Device /= Device Operation / Control Virtqueue} + +The driver uses the control virtqueue to send control commands to the +device, such as session operations (See \ref{sec:Device Types / Crypto Dev= ice / Device Operation / Control Virtqueue / Session operation}). + +The header for controlq is of the following form: +\begin{lstlisting} +#define VIRTIO_CRYPTO_OPCODE(service, op) (((service) << 8) | (op)) + +struct virtio_crypto_ctrl_header { +#define VIRTIO_CRYPTO_CIPHER_CREATE_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x02) +#define VIRTIO_CRYPTO_CIPHER_DESTROY_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x03) +#define VIRTIO_CRYPTO_HASH_CREATE_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_HASH, 0x02) +#define VIRTIO_CRYPTO_HASH_DESTROY_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_HASH, 0x03) +#define VIRTIO_CRYPTO_MAC_CREATE_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_MAC, 0x02) +#define VIRTIO_CRYPTO_MAC_DESTROY_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_MAC, 0x03) +#define VIRTIO_CRYPTO_AEAD_CREATE_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x02) +#define VIRTIO_CRYPTO_AEAD_DESTROY_SESSION \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x03) + le32 opcode; + /* algo should be service-specific algorithms */ + le32 algo; + le32 flag; + /* data virtqueue id */ + le32 queue_id; +}; +\end{lstlisting} + +The format of the controlq request depends on the VIRTIO_CRYPTO_F_MUX_MODE= feature bit: + +\begin{itemize*} +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is NOT negotiated the co= ntrolq request is + a fixed-size structure of form: +\begin{lstlisting} +struct virtio_crypto_op_ctrl_req { + struct virtio_crypto_ctrl_header header; + + union { + struct virtio_crypto_sym_create_session_req sym_create_session; + struct virtio_crypto_hash_create_session_req hash_create_session; + struct virtio_crypto_mac_create_session_req mac_create_session; + struct virtio_crypto_aead_create_session_req aead_create_session; + struct virtio_crypto_destroy_session_req destroy_session; + } u; +}; +\end{lstlisting} +The header is the general header, and the union is of the algorithm-specif= ic type or the +virtio_crypto_destroy_session_req structure, which is set by the driver. A= ll the properties +in the union are shown as follows. + +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated the contro= lq request is composed + of two parts, the additional paramenters are preceded by the general h= eader. + +\begin{lstlisting} +struct virtio_crypto_op_ctrl_req_mux { + struct virtio_crypto_ctrl_header header; + + /* additional paramenter */ + u8 additional_para[addl_para_len]; +}; +\end{lstlisting} + +The additional paramenters are stored in a virtio_crypto_destroy_session_r= eq structure or +in a algorithm-specific structure: +\begin{itemize*} +\item struct virtio_crypto_sym_create_session_req +\item struct virtio_crypto_hash_create_session_req +\item struct virtio_crypto_mac_create_session_req +\item struct virtio_crypto_aead_create_session_req +\end{itemize*} +All of the structures above are shown as follows. +\end{itemize*} + +\paragraph{Session operation}\label{sec:Device Types / Crypto Device / Dev= ice Operation / Control Virtqueue / Session operation} + +The session is a +handle which describes the cryptographic parameters to be applied to +a number of buffers. + +The following structure stores the result of session creation set by the d= evice: + +\begin{lstlisting} +struct virtio_crypto_session_input { + /* Device-writable part */ + le64 session_id; + le32 status; + le32 padding; +}; +\end{lstlisting} + +A request to destroy a session includes the following information: + +\begin{lstlisting} +struct virtio_crypto_destroy_session_req { + /* Device-readable part */ + le64 session_id; + /* Device-writable part */ + le32 status; + le32 padding; +}; +\end{lstlisting} + +\subparagraph{Session operation: HASH session}\label{sec:Device Types / Cr= ypto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: HAS= H session} + +HASH session requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_hash_session_para { + /* See VIRTIO_CRYPTO_HASH_* above */ + le32 algo; + /* hash result length */ + le32 hash_result_len; +}; +struct virtio_crypto_hash_create_session_req { + /* Device-readable part */ + struct virtio_crypto_hash_session_para para; + /* Device-writable part */ + struct virtio_crypto_session_input input; +}; +\end{lstlisting} + +The information required by HASH session creation is stored in the virtio_= crypto_hash_create_session_req +structure, including the hash parameters stored in \field{para}. \field{in= put} stores the result of this operation. + +\subparagraph{Session operation: MAC session}\label{sec:Device Types / Cry= pto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: MAC= session} + +MAC session requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_mac_session_para { + /* See VIRTIO_CRYPTO_MAC_* above */ + le32 algo; + /* hash result length */ + le32 hash_result_len; + /* length of authenticated key */ + le32 auth_key_len; + le32 padding; +}; + +struct virtio_crypto_mac_create_session_req { + /* Device-readable part */ + struct virtio_crypto_mac_session_para para; + /* The authenticated key */ + u8 auth_key[auth_key_len]; + + /* Device-writable part */ + struct virtio_crypto_session_input input; +}; +\end{lstlisting} + +The information required by MAC session creation is stored in the virtio_c= rypto_mac_create_session_req +structure, including the mac parameters stored in \field{para} and the aut= henticated key in \field{auth_key}. +\field{input} stores the result of this operation. + +\subparagraph{Session operation: Symmetric algorithms session}\label{sec:D= evice Types / Crypto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: Sym= metric algorithms session} + +The request of symmetric session includes two parts, CIPHER algorithms and= chain +algorithms (chaining CIPHER and HASH/MAC). + +CIPHER session requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_cipher_session_para { + /* See VIRTIO_CRYPTO_CIPHER* above */ + le32 algo; + /* length of key */ + le32 keylen; +#define VIRTIO_CRYPTO_OP_ENCRYPT 1 +#define VIRTIO_CRYPTO_OP_DECRYPT 2 + /* encryption or decryption */ + le32 op; + le32 padding; +}; + +struct virtio_crypto_cipher_session_req { + /* Device-readable part */ + struct virtio_crypto_cipher_session_para para; + /* The cipher key */ + u8 cipher_key[keylen]; + + /* Device-writable part */ + struct virtio_crypto_session_input input; +}; +\end{lstlisting} + +Algorithm chaining requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_alg_chain_session_para { +#define VIRTIO_CRYPTO_SYM_ALG_CHAIN_ORDER_HASH_THEN_CIPHER 1 +#define VIRTIO_CRYPTO_SYM_ALG_CHAIN_ORDER_CIPHER_THEN_HASH 2 + le32 alg_chain_order; +/* Plain hash */ +#define VIRTIO_CRYPTO_SYM_HASH_MODE_PLAIN 1 +/* Authenticated hash (mac) */ +#define VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH 2 +/* Nested hash */ +#define VIRTIO_CRYPTO_SYM_HASH_MODE_NESTED 3 + le32 hash_mode; + struct virtio_crypto_cipher_session_para cipher_param; + union { + struct virtio_crypto_hash_session_para hash_param; + struct virtio_crypto_mac_session_para mac_param; + } u; + /* length of the additional authenticated data (AAD) in bytes */ + le32 aad_len; + le32 padding; +}; + +struct virtio_crypto_alg_chain_session_req { + /* Device-readable part */ + struct virtio_crypto_alg_chain_session_para para; + /* The cipher key */ + u8 cipher_key[keylen]; + /* The authenticated key */ + u8 auth_key[auth_key_len]; + + /* Device-writable part */ + struct virtio_crypto_session_input input; +}; +\end{lstlisting} + +Symmetric algorithm requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_sym_create_session_req { + union { + struct virtio_crypto_cipher_session_req cipher; + struct virtio_crypto_alg_chain_session_req chain; + } u; + + /* Device-readable part */ + +/* No operation */ +#define VIRTIO_CRYPTO_SYM_OP_NONE 0 +/* Cipher only operation on the data */ +#define VIRTIO_CRYPTO_SYM_OP_CIPHER 1 +/* Chain any cipher with any hash or mac operation. The order + depends on the value of alg_chain_order param */ +#define VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING 2 + le32 op_type; + le32 padding; +}; +\end{lstlisting} + +The information required by symmetric algorithms session creation is store= d in the +virtio_crypto_sym_create_session_req structure, including the symmetric op= eration +type in \field{op_type} and the cipher parameters stored in \field{cipher}= or the +algorithm chaining paramenters in \field{chain}. + +The driver can set the \field{op_type} field in struct virtio_crypto_sym_c= reate_session_req +as follows: VIRTIO_CRYPTO_SYM_OP_NONE: no operation; VIRTIO_CRYPTO_SYM_OP_= CIPHER: Cipher only +operation on the data; VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING: Chain any = cipher with any hash +or mac operation. + +\subparagraph{Session operation: AEAD session}\label{sec:Device Types / Cr= ypto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: AEA= D session} + +AEAD session requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_aead_session_para { + /* See VIRTIO_CRYPTO_AEAD_* above */ + le32 algo; + /* length of key */ + le32 key_len; + /* Authentication tag length */ + le32 tag_len; + /* The length of the additional authenticated data (AAD) in bytes */ + le32 aad_len; + /* encryption or decryption, See above VIRTIO_CRYPTO_OP_* */ + le32 op; + le32 padding; +}; + +struct virtio_crypto_aead_create_session_req { + /* Device-readable part */ + struct virtio_crypto_aead_session_para para; + u8 key[key_len]; + + /* Device-writeable part */ + struct virtio_crypto_session_input input; +}; +\end{lstlisting} + +The information required by AEAD session creation is stored in the virtio_= crypto_aead_create_session_req +structure, including the aead parameters stored in \field{para} and the ci= pher key in \field{key}. +\field{input} stores the result of this operation. + +\drivernormative{\subparagraph}{Session operation: create session}{Device = Types / Crypto Device / Device Operation / Control Virtqueue / Session oper= ation / Session operation: create session} + +\begin{itemize*} +\item The driver MUST set the control general header and the corresponding= algorithm-specific structure. + See \ref{sec:Device Types / Crypto Device / Device Operation / Control= Virtqueue}. +\item The driver MUST set the \field{opcode} field based on service type: = CIPHER, HASH, MAC, or AEAD. +\item The driver MUST set the \field{queue_id} field to show used dataq. +\end{itemize*} + +\devicenormative{\subparagraph}{Session operation: create session}{Device = Types / Crypto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: cre= ate session} + +\begin{itemize*} +\item The device MUST use the corresponding algorithm-specific structure a= ccording to the + \field{opcode} in the control general header. +\item The device MUST set the \field{status} field to one of the following= values of enum + VIRTIO_CRYPTO_STATUS after finish a session creation: +\begin{itemize*} +\item VIRTIO_CRYPTO_OK if a session is created successfully. +\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is uns= upported. +\item VIRTIO_CRYPTO_NOSPC if no free session ID (only when the VIRTIO_CRYP= TO_F_MUX_MODE + feature bit is negotiated). +\item VIRTIO_CRYPTO_ERR if failure not mentioned above occurs. +\end{itemize*} +\item The device MUST set the \field{session_id} field to a unique session= identifieronly + if the status is set to VIRTIO_CRYPTO_OK. +\end{itemize*} + +\drivernormative{\subparagraph}{Session operation: destroy session}{Device= Types / Crypto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: des= troy session} + +\begin{itemize*} +\item The driver MUST set the \field{opcode} field based on service type: = CIPHER, HASH, MAC, or AEAD. +\item The driver MUST set the \field{session_id} to a valid value assigned= by the device + when the session was created. +\end{itemize*} + +\devicenormative{\subparagraph}{Session operation: destroy session}{Device= Types / Crypto Device / Device +Operation / Control Virtqueue / Session operation / Session operation: des= troy session} + +\begin{itemize*} +\item The device MUST set the \field{status} field to one of the following= values of enum VIRTIO_CRYPTO_STATUS. +\begin{itemize*} +\item VIRTIO_CRYPTO_OK if a session is created successfully. +\item VIRTIO_CRYPTO_ERR if any failure occurs. +\end{itemize*} +\end{itemize*} + +\subsubsection{Data Virtqueue}\label{sec:Device Types / Crypto Device / De= vice Operation / Data Virtqueue} + +The driver uses the data virtqueues to transmit crypto operation requests = to the device, +and completes the crypto operations. + +The header for dataq is as follows: + +\begin{lstlisting} +struct virtio_crypto_op_header { +#define VIRTIO_CRYPTO_CIPHER_ENCRYPT \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x00) +#define VIRTIO_CRYPTO_CIPHER_DECRYPT \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_CIPHER, 0x01) +#define VIRTIO_CRYPTO_HASH \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_HASH, 0x00) +#define VIRTIO_CRYPTO_MAC \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_MAC, 0x00) +#define VIRTIO_CRYPTO_AEAD_ENCRYPT \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x00) +#define VIRTIO_CRYPTO_AEAD_DECRYPT \ + VIRTIO_CRYPTO_OPCODE(VIRTIO_CRYPTO_SERVICE_AEAD, 0x01) + le32 opcode; + /* algo should be service-specific algorithms */ + le32 algo; + le64 session_id; +#define VIRTIO_CRYPTO_FLAG_SESSION_MODE 1 + /* control flag to control the request */ + le32 flag; + le32 padding; +}; +\end{lstlisting} + +The format of the dataq request depends on the VIRTIO_CRYPTO_F_MUX_MODE fe= ature bit: + +\begin{itemize*} +\item If VIRTIO_CRYPTO_F_MUX_MODE feature bit is NOT negotiated the dataq = request is + a fixed-size structure of form: + +\begin{lstlisting} +struct virtio_crypto_op_data_req { + struct virtio_crypto_op_header header; + + union { + struct virtio_crypto_sym_data_req sym_req; + struct virtio_crypto_hash_data_req hash_req; + struct virtio_crypto_mac_data_req mac_req; + struct virtio_crypto_aead_data_req aead_req; + } u; +}; +\end{lstlisting} + +The header is the general header, and the union is of the algorithm-specif= ic type, +which is set by the driver. All the properties in the union are shown as f= ollows. + +\item If VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated the dataq requ= ests is + composed of two parts, the additional paramenters are preceded by the = general header: + +\begin{lstlisting} +struct virtio_crypto_op_data_req_mux { + struct virtio_crypto_op_header header; + + /* additional paramenter of the operation */ + u8 additional_para[addl_para_len]; +}; +\end{lstlisting} + +The additional paramenters are stored in a algorithm-specific structure: +\begin{itemize*} +\item struct virtio_crypto_sym_data_req +\item struct virtio_crypto_hash_data_req +\item struct virtio_crypto_mac_data_req +\item struct virtio_crypto_aead_data_req +\item struct virtio_crypto_sym_data_req_stateless +\item struct virtio_crypto_hash_data_req_stateless +\item struct virtio_crypto_mac_data_req_stateless +\item struct virtio_crypto_aead_data_req_stateless +\end{itemize*} +All of the structures above are shown as follows. +\end{itemize*} + +There is a unified input header for all crypto services, is defined as fol= lows: + +\begin{lstlisting} +struct virtio_crypto_inhdr { + u8 status; +}; +\end{lstlisting} + +\subsubsection{HASH Service Operation}\label{sec:Device Types / Crypto Dev= ice / Device Operation / HASH Service Operation} + +Session mode HASH service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_hash_para { + /* length of source data */ + le32 src_data_len; + /* hash result length */ + le32 hash_result_len; +}; + +struct virtio_crypto_hash_data_req { + /* Device-readable part */ + struct virtio_crypto_hash_para para; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Hash result data */ + u8 hash_result[hash_result_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +Each data request uses virtio_crypto_hash_data_req structure to store info= rmation +used to run the HASH operations. + +The information includes the hash parameters stored in \field{para}, outpu= t data +and input data. The output data here includes the source data and the inpu= t data +includes the hash result data used to save the results of the HASH operati= ons. +\field{inhdr} stores the status of executing the HASH operations. + +Stateless mode HASH service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_hash_para_statelesss { + struct { + /* See VIRTIO_CRYPTO_HASH_* above */ + le32 algo; + } sess_para; + + /* length of source data */ + le32 src_data_len; + /* hash result length */ + le32 hash_result_len; + le32 reserved; +}; +struct virtio_crypto_hash_data_req_stateless { + /* Device-readable part */ + struct virtio_crypto_hash_para_stateless para; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Hash result data */ + u8 hash_result[hash_result_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +\drivernormative{\paragraph}{HASH Service Operation}{Device Types / Crypto= Device / Device Operation / HASH Service Operation} + +\begin{itemize*} +\item If the driver uses the session mode, then the driver MUST set \field= {session_id} + in struct virtio_crypto_op_header to a valid value assigned by the dev= ice when the + session was created. +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the drive= r MUST use + struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwis= e, the driver + MUST use struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_HASH_STATELESS_MODE feature bit is negotiated= , 1) if the + driver uses the stateless mode, then the driver MUST set the \field{fl= ag} field in + struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE and M= UST set the + fields in struct virtio_crypto_hash_para_stateless.sess_para, 2) if the d= river uses + the session mode, then the driver MUST set the \field{flag} field in stru= ct + virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE. +\item The driver MUST set \field{opcode} in struct virtio_crypto_op_header= to VIRTIO_CRYPTO_HASH. +\end{itemize*} + +\devicenormative{\paragraph}{HASH Service Operation}{Device Types / Crypto= Device / Device Operation / HASH Service Operation} + +\begin{itemize*} +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the devic= e MUST parse + the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwis= e, the device + MUST parse the struct virtio_crypto_op_data_req. +\item The device MUST use the corresponding algorithm-specific structure a= ccording to + the \field{opcode} in the data general header. +\item If the VIRTIO_CRYPTO_F_HASH_STATELESS_MODE feature bit is negotiated= , the device + MUST parse \field{flag} field in struct virtio_crypto_op_header in ord= er to decide + which mode the driver uses. +\item The device MUST copy the results of HASH operations in the hash_resu= lt[] if HASH + operations success. +\item The device MUST set \field{status} in struct virtio_crypto_inhdr to = one of the + following values of enum VIRTIO_CRYPTO_STATUS: +\begin{itemize*} +\item VIRTIO_CRYPTO_OK if the operation success. +\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is uns= upported. +\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode. +\item VIRTIO_CRYPTO_ERR if any failure not mentioned above occurs. +\end{itemize*} +\end{itemize*} + +\subsubsection{MAC Service Operation}\label{sec:Device Types / Crypto Devi= ce / Device Operation / MAC Service Operation} + +Session mode MAC service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_mac_para { + struct virtio_crypto_hash_para hash; +}; + +struct virtio_crypto_mac_data_req { + /* Device-readable part */ + struct virtio_crypto_mac_para para; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Hash result data */ + u8 hash_result[hash_result_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +Each request uses the virtio_crypto_mac_data_req structure to store inform= ation +used to run the MAC operations. + +The information includes the hash parameters stored in \field{para}, outpu= t data +and input data. The output data here includes the source data and the inpu= t data +includes the hash result data used to save the results of the MAC operatio= ns. +\field{inhdr} stores the status of executing the MAC operations. + +Stateless mode MAC service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_mac_para_stateless { + struct { + /* See VIRTIO_CRYPTO_MAC_* above */ + le32 algo; + /* length of authenticated key */ + le32 auth_key_len; + } sess_para; + + /* length of source data */ + le32 src_data_len; + /* hash result length */ + le32 hash_result_len; +}; + +struct virtio_crypto_mac_data_req_stateless { + /* Device-readable part */ + struct virtio_crypto_mac_para_stateless para; + /* The authenticated key */ + u8 auth_key[auth_key_len]; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Hash result data */ + u8 hash_result[hash_result_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +\drivernormative{\paragraph}{MAC Service Operation}{Device Types / Crypto = Device / Device Operation / MAC Service Operation} + +\begin{itemize*} +\item If the driver uses the session mode, then the driver MUST set \field= {session_id} + in struct virtio_crypto_op_header to a valid value assigned by the dev= ice when the + session was created. +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the drive= r MUST use + struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwis= e, the + driver MUST use struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_MAC_STATELESS_MODE feature bit is negotiated,= 1) if the + driver uses the stateless mode, then the driver MUST set the \field{fl= ag} field + in struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE an= d MUST + set the fields in struct virtio_crypto_mac_para_stateless.sess_para, 2) i= f the + driver uses the session mode, then the driver MUST set the \field{flag} f= ield in + struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE. +\item The driver MUST set \field{opcode} in struct virtio_crypto_op_header= to VIRTIO_CRYPTO_MAC. +\end{itemize*} + +\devicenormative{\paragraph}{MAC Service Operation}{Device Types / Crypto = Device / Device Operation / MAC Service Operation} + +\begin{itemize*} +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the devic= e MUST parse + the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwis= e, the device + MUST parse the struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_MAC_STATELESS_MODE feature bit is negotiated,= the device + MUST parse \field{flag} field in struct virtio_crypto_op_header in ord= er to decide + which mode the driver uses. +\item The device MUST copy the results of MAC operations in the hash_resul= t[] if HASH + operations success. +\item The device MUST set \field{status} in struct virtio_crypto_inhdr to = one of the + following values of enum VIRTIO_CRYPTO_STATUS: +\begin{itemize*} +\item VIRTIO_CRYPTO_OK if the operation success. +\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is uns= upported. +\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode. +\item VIRTIO_CRYPTO_ERR if any failure not mentioned above occurs. +\end{itemize*} +\end{itemize*} + +\subsubsection{Symmetric algorithms Operation}\label{sec:Device Types / Cr= ypto Device / Device Operation / Symmetric algorithms Operation} + +Session mode CIPHER service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_cipher_para { + /* + * Byte Length of valid IV/Counter data pointed to by the below iv dat= a. + * + * For block ciphers in CBC or F8 mode, or for Kasumi in F8 mode, or f= or + * SNOW3G in UEA2 mode, this is the length of the IV (which + * must be the same as the block length of the cipher). + * For block ciphers in CTR mode, this is the length of the counter + * (which must be the same as the block length of the cipher). + */ + le32 iv_len; + /* length of source data */ + le32 src_data_len; + /* length of destination data */ + le32 dst_data_len; + le32 padding; +}; + +struct virtio_crypto_cipher_data_req { + /* Device-readable part */ + struct virtio_crypto_cipher_para para; + /* + * Initialization Vector or Counter data. + * + * For block ciphers in CBC or F8 mode, or for Kasumi in F8 mode, or f= or + * SNOW3G in UEA2 mode, this is the Initialization Vector (IV) + * value. + * For block ciphers in CTR mode, this is the counter. + * For AES-XTS, this is the 128bit tweak, i, from IEEE Std 1619-2007. + * + * The IV/Counter will be updated after every partial cryptographic + * operation. + */ + u8 iv[iv_len]; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Destination data */ + u8 dst_data[dst_data_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +Session mode requests of algorithm chaining are as follows: + +\begin{lstlisting} +struct virtio_crypto_alg_chain_data_para { + le32 iv_len; + /* Length of source data */ + le32 src_data_len; + /* Length of destination data */ + le32 dst_data_len; + /* Starting point for cipher processing in source data */ + le32 cipher_start_src_offset; + /* Length of the source data that the cipher will be computed on */ + le32 len_to_cipher; + /* Starting point for hash processing in source data */ + le32 hash_start_src_offset; + /* Length of the source data that the hash will be computed on */ + le32 len_to_hash; + /* Length of the additional auth data */ + le32 aad_len; + /* Length of the hash result */ + le32 hash_result_len; + le32 reserved; +}; + +struct virtio_crypto_alg_chain_data_req { + /* Device-readable part */ + struct virtio_crypto_alg_chain_data_para para; + /* Initialization Vector or Counter data */ + u8 iv[iv_len]; + /* Source data */ + u8 src_data[src_data_len]; + /* Additional authenticated data if exists */ + u8 aad[aad_len]; + + /* Device-writable part */ + /* Destination data */ + u8 dst_data[dst_data_len]; + /* Hash result data */ + u8 hash_result[hash_result_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +Session mode requests of symmetric algorithm are as follows: + +\begin{lstlisting} +struct virtio_crypto_sym_data_req { + union { + struct virtio_crypto_cipher_data_req cipher; + struct virtio_crypto_alg_chain_data_req chain; + } u; + + /* Device-readable part */ + + /* See above VIRTIO_CRYPTO_SYM_OP_* */ + le32 op_type; + le32 padding; +}; +\end{lstlisting} + +Each request uses the virtio_crypto_sym_data_req structure to store inform= ation +used to run the CIPHER operations. + +The information includes the cipher parameters stored in \field{para}, out= put data +and input data. In the first virtio_crypto_cipher_para structure, \field{i= v_len} +specifies the length of the initialization vector or counter, \field{src_d= ata_len} +specifies the length of the source data, and \field{dst_data_len} specifie= s the length +of the destination data. For plain CIPHER operations, the output data here= includes +the IV/Counter data and source data, and the input data includes the desti= nation data +used to save the results of the CIPHER operations. + +For algorithms chain, the output data here includes the IV/Counter data, s= ource data +and additional authenticated data if exists. The input data includes both = destination +data and hash result data used to store the results of the HASH/MAC operat= ions. +\field{inhdr} stores the status of executing the crypto operations. + +Stateless mode CIPHER service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_cipher_para_stateless { + struct { + /* See VIRTIO_CRYPTO_CIPHER* above */ + le32 algo; + /* length of key */ + le32 keylen; + + /* See VIRTIO_CRYPTO_OP_* above */ + le32 op; + } sess_para; + + /* + * Byte Length of valid IV/Counter data pointed to by the below iv dat= a. + */ + le32 iv_len; + /* length of source data */ + le32 src_data_len; + /* length of destination data */ + le32 dst_data_len; +}; + +struct virtio_crypto_cipher_data_req_stateless { + /* Device-readable part */ + struct virtio_crypto_cipher_para_stateless para; + /* The cipher key */ + u8 cipher_key[keylen]; + + /* Initialization Vector or Counter data. */ + u8 iv[iv_len]; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Destination data */ + u8 dst_data[dst_data_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +Stateless mode requests of algorithm chaining are as follows: + +\begin{lstlisting} +struct virtio_crypto_alg_chain_data_para_stateless { + struct { + /* See VIRTIO_CRYPTO_SYM_ALG_CHAIN_ORDER_* above */ + le32 alg_chain_order; + /* length of the additional authenticated data in bytes */ + le32 aad_len; + + struct { + /* See VIRTIO_CRYPTO_CIPHER* above */ + le32 algo; + /* length of key */ + le32 keylen; + /* See VIRTIO_CRYPTO_OP_* above */ + le32 op; + } cipher; + + struct { + /* See VIRTIO_CRYPTO_HASH_* or VIRTIO_CRYPTO_MAC_* above */ + le32 algo; + /* length of authenticated key */ + le32 auth_key_len; + /* See VIRTIO_CRYPTO_SYM_HASH_MODE_* above */ + le32 hash_mode; + } hash; + } sess_para; + + le32 iv_len; + /* Length of source data */ + le32 src_data_len; + /* Length of destination data */ + le32 dst_data_len; + /* Starting point for cipher processing in source data */ + le32 cipher_start_src_offset; + /* Length of the source data that the cipher will be computed on */ + le32 len_to_cipher; + /* Starting point for hash processing in source data */ + le32 hash_start_src_offset; + /* Length of the source data that the hash will be computed on */ + le32 len_to_hash; + /* Length of the additional auth data */ + le32 aad_len; + /* Length of the hash result */ + le32 hash_result_len; + le32 reserved; +}; + +struct virtio_crypto_alg_chain_data_req_stateless { + /* Device-readable part */ + struct virtio_crypto_alg_chain_data_para_stateless para; + /* The cipher key */ + u8 cipher_key[keylen]; + /* The auth key */ + u8 auth_key[auth_key_len]; + /* Initialization Vector or Counter data */ + u8 iv[iv_len]; + /* Additional authenticated data if exists */ + u8 aad[aad_len]; + /* Source data */ + u8 src_data[src_data_len]; + + /* Device-writable part */ + /* Destination data */ + u8 dst_data[dst_data_len]; + /* Hash result data */ + u8 hash_result[hash_result_len]; + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + * header + key + auth_key + iv + srd_data + aad + dst_data + hash_= result +Stateless mode requests of symmetric algorithm are as follows: + +\begin{lstlisting} +struct virtio_crypto_sym_data_req_stateless { + union { + struct virtio_crypto_cipher_data_req_stateless cipher; + struct virtio_crypto_alg_chain_data_req_stateless chain; + } u; + + /* Device-readable part */ + + /* See above VIRTIO_CRYPTO_SYM_OP_* */ + le32 op_type; + /* Data virtqueue id */ + uint32_t queue_id; +}; +\end{lstlisting} + +\drivernormative{\paragraph}{Symmetric algorithms Operation}{Device Types = / Crypto Device / Device Operation / Symmetric algorithms Operation} + +\begin{itemize*} +\item If the driver uses the session mode, then the driver MUST set \field= {session_id} + in struct virtio_crypto_op_header to a valid value assigned by the dev= ice when the + session was created. +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the drive= r MUST use + struct virtio_crypto_op_data_req_mux to wrap crypto requests. Otherwis= e, the driver + MUST use struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE feature bit is negotiat= ed, 1) if the + driver uses the stateless mode, then the driver MUST set the \field{fl= ag} field in + struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_MODE and M= UST set the + fields in struct virtio_crypto_cipher_para_stateless.sess_para or struct + virtio_crypto_alg_chain_data_para_stateless.sess_para, 2) if the driver u= ses the + session mode, then the driver MUST set the \field{flag} field in struct + virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MODE. +\item The driver MUST set the \field{opcode} field in struct virtio_crypto= _op_header + to VIRTIO_CRYPTO_CIPHER_ENCRYPT or VIRTIO_CRYPTO_CIPHER_DECRYPT. +\item The driver MUST specify the fields of struct virtio_crypto_cipher_da= ta_req in + struct virtio_crypto_sym_data_req if the request is based on VIRTIO_CR= YPTO_SYM_OP_CIPHER. +\item The driver MUST specify the fields of both struct virtio_crypto_ciph= er_data_req + and struct virtio_crypto_mac_data_req in struct virtio_crypto_sym_data= _req if the request + is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type and in the VIRTIO_= CRYPTO_SYM_HASH_MODE_AUTH mode. +\end{itemize*} + +\devicenormative{\paragraph}{Symmetric algorithms Operation}{Device Types = / Crypto Device / Device Operation / Symmetric algorithms Operation} + +\begin{itemize*} +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the devic= e MUST parse + the struct virtio_crypto_op_data_req_mux for crypto requests. Otherwis= e, the device + MUST parse the struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_CIPHER_STATELESS_MODE feature bit is negotiat= ed, the device + MUST parse \field{flag} field in struct virtio_crypto_op_header in ord= er to decide + which mode the driver uses. +\item The device MUST parse the virtio_crypto_sym_data_req based on the \f= ield{opcode} + field in general header. +\item The device SHOULD only parse fields of struct virtio_crypto_cipher_d= ata_req in + struct virtio_crypto_sym_data_req if the request is VIRTIO_CRYPTO_SYM_= OP_CIPHER type. +\item The device MUST parse fields of both struct virtio_crypto_cipher_dat= a_req and + struct virtio_crypto_mac_data_req in struct virtio_crypto_sym_data_req= if the request + is of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING operation type and in t= he + VIRTIO_CRYPTO_SYM_HASH_MODE_AUTH mode. +\item The device MUST copy the result of cryptographic operation in the ds= t_data[] in + both plain CIPHER mode and algorithms chain mode. +\item The device MUST check the \field{para}.\field{add_len} is bigger tha= n 0 before + parse the additional authenticated data in plain algorithms chain mode. +\item The device MUST copy the result of HASH/MAC operation in the hash_re= sult[] is + of the VIRTIO_CRYPTO_SYM_OP_ALGORITHM_CHAINING type. +\item The device MUST set the \field{status} field in struct virtio_crypto= _inhdr to + one of the following values of enum VIRTIO_CRYPTO_STATUS: +\begin{itemize*} +\item VIRTIO_CRYPTO_OK if the operation success. +\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is uns= upported. +\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode. +\item VIRTIO_CRYPTO_ERR if failure not mentioned above occurs. +\end{itemize*} +\end{itemize*} + +\paragraph{Steps of Operation}\label{sec:Device Types / Crypto Device / De= vice Operation / Symmetric algorithms Operation / Steps of Operation} + +The following is a example of the flow of work between the driver and the = device if the VIRTIO_CRYPTO_F_MUX_MODE feature bit is NOT negotiated. + +\subparagraph{Step1: Create session}\label{sec:Device Types / Crypto Devic= e / Device Operation / Symmetric algorithms Operation / Steps of Operation = / Step1: Create session on session mode} + +\begin{enumerate} +\item The driver specifies information in struct virtio_crypto_op_ctrl_req= , including + the algorithm name, key, keylen etc; +\item The driver adds the request of session creation into the controlq's = Vring Descriptor Table; +\item The driver kicks the device; +\item The device receives the request from controlq; +\item The device parses information about the request, and determines the = information + concerning the crypto accelerator; +\item The device packs information based on the APIs of the crypto acceler= ator; +\item The device invokes the session creation APIs of the crypto accelerat= or to create a session; +\item The device returns the session id to the driver. +\end{enumerate} + +\subparagraph{Step2: Execute cryptographic operation}\label{sec:Device Typ= es / Crypto Device / Device Operation / Symmetric algorithms Operation / St= eps of Operation / Step2: Execute cryptographic operation} + +\begin{enumerate} +\item The driver specifies information in struct virtio_crypto_op_data_req= , including + struct virtio_crypto_op_header and struct virtio_crypto_sym_data_req, + see \ref{sec:Device Types / Crypto Device / Device Operation / Symmetric = algorithms Operation}; +\item The driver adds the request for cryptographic operation into the dat= aq's Vring Descriptor Table; +\item The driver kicks the device (Or the device actively polls the dataq'= s Vring Descriptor Table); +\item The device receives the request from dataq; +\item The device parses information about the request, and determines the = identification + information for the crypto accelerator. For example, converting guest = physical + addresses to host physical addresses; +\item The device packs identification information based on the API of the = crypto accelerator; +\item The device invokes the cryptographic APIs of the crypto accelerator; +\item The crypto accelerator executes the cryptographic operation implicit= ly; +\item The device receives the cryptographic results from the crypto accele= rator (synchronous or asynchronous); +\item The device sets the \field{status} in struct virtio_crypto_inhdr; +\item The device updates and flushes the Used Ring to return the cryptogra= phic results to the driver; +\item The device notifies the driver (Or the driver actively polls the dat= aq's Used Ring); +\item The driver saves the cryptographic results. +\end{enumerate} + +\subsubsection{AEAD Service Operation}\label{sec:Device Types / Crypto Dev= ice / Device Operation / AEAD Service Operation} + +Session mode requests of symmetric algorithm are as follows: + +\begin{lstlisting} +struct virtio_crypto_aead_para { + /* + * Byte Length of valid IV data. + * + * For GCM mode, this is either 12 (for 96-bit IVs) or 16, in which + * case iv points to J0. + * For CCM mode, this is the length of the nonce, which can be in the + * range 7 to 13 inclusive. + */ + le32 iv_len; + /* length of additional auth data */ + le32 aad_len; + /* length of source data */ + le32 src_data_len; + /* length of dst data, this should be at least src_data_len + tag_len = */ + le32 dst_data_len; + /* Authentication tag length */ + le32 tag_len; + le32 reserved; +}; + +struct virtio_crypto_aead_data_req { + /* Device-readable part */ + struct virtio_crypto_aead_para para; + /* + * Initialization Vector data. + * + * For GCM mode, this is either the IV (if the length is 96 bits) or J0 + * (for other sizes), where J0 is as defined by NIST SP800-38D. + * Regardless of the IV length, a full 16 bytes needs to be allocate= d. + * For CCM mode, the first byte is reserved, and the nonce should be + * written starting at &iv[1] (to allow space for the implementation + * to write in the flags in the first byte). Note that a full 16 by= tes + * should be allocated, even though the iv_len field will have + * a value less than this. + * + * The IV will be updated after every partial cryptographic operation. + */ + u8 iv[iv_len]; + /* Source data */ + u8 src_data[src_data_len]; + /* Additional authenticated data if exists */ + u8 aad[aad_len]; + + /* Device-writable part */ + /* Pointer to output data */ + u8 dst_data[dst_data_len]; + + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +Each data request uses virtio_crypto_aead_data_req structure to store info= rmation +used to run the AEAD operations. + +The information includes the hash parameters stored in \field{para}, outpu= t data +and input data. In the first virtio_crypto_aead_para structure, \field{iv_= len} +specifies the length of the initialization vector. \field{tag_len} specifi= es the +length of the authentication tag; \field{aad_len} specifies the length of = additional +authentication data, \field{src_data_len} specifies the length of the sour= ce data; +\field{dst_data_len} specifies the length of the destination data, which i= s at least +\field{src_data_len} + \field{tag_len}. + +The output data here includes the IV/Counter data, source data and additio= nal +authenticated data if exists. The input data includes both destination dat= a used +to save the results of the AEAD operations. \field{inhdr} stores the statu= s of +executing the AEAD operations. + +Stateless mode AEAD service requests are as follows: + +\begin{lstlisting} +struct virtio_crypto_aead_para_stateless { + struct { + /* See VIRTIO_CRYPTO_AEAD_* above */ + le32 algo; + /* length of key */ + le32 key_len; + /* encrypt or decrypt, See above VIRTIO_CRYPTO_OP_* */ + le32 op; + } sess_para; + + /* Byte Length of valid IV data. */ + le32 iv_len; + /* Authentication tag length */ + le32 tag_len; + /* length of additional auth data */ + le32 aad_len; + /* length of source data */ + le32 src_data_len; + /* length of dst data, this should be at least src_data_len + tag_len = */ + le32 dst_data_len; +}; + +struct virtio_crypto_aead_data_req_stateless { + /* Device-readable part */ + struct virtio_crypto_aead_para_stateless para; + /* The cipher key */ + u8 key[key_len]; + /* Initialization Vector data. */ + u8 iv[iv_len]; + /* Source data */ + u8 src_data[src_data_len]; + /* Additional authenticated data if exists */ + u8 aad[aad_len]; + + /* Device-writable part */ + /* Pointer to output data */ + u8 dst_data[dst_data_len]; + + struct virtio_crypto_inhdr inhdr; +}; +\end{lstlisting} + +\drivernormative{\paragraph}{AEAD Service Operation}{Device Types / Crypto= Device / Device Operation / AEAD Service Operation} + +\begin{itemize*} +\item If the driver uses the session mode, then the driver MUST set + \field{session_id} in struct virtio_crypto_op_header to a valid value = assigned + by the device when the session was created. +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the drive= r MUST + use struct virtio_crypto_op_data_req_mux to wrap crypto requests. Othe= rwise, + the driver MUST use struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE feature bit is negotiated= , 1) if + the driver uses the stateless mode, then the driver MUST set the \fiel= d{flag} + field in struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_STATELESS_M= ODE + and MUST set the fields in struct virtio_crypto_aead_para_stateless.sess_= para, + 2) if the driver uses the session mode, then the driver MUST set the \fie= ld{flag} + field in struct virtio_crypto_op_header to VIRTIO_CRYPTO_FLAG_SESSION_MOD= E. +\item The driver MUST set the \field{opcode} field in struct virtio_crypto= _op_header + to VIRTIO_CRYPTO_AEAD_ENCRYPT or VIRTIO_CRYPTO_AEAD_DECRYPT. +\end{itemize*} + +\devicenormative{\paragraph}{AEAD Service Operation}{Device Types / Crypto= Device / Device Operation / AEAD Service Operation} + +\begin{itemize*} +\item If the VIRTIO_CRYPTO_F_MUX_MODE feature bit is negotiated, the devic= e MUST + parse the struct virtio_crypto_op_data_req_mux for crypto requests. Ot= herwise, + the device MUST parse the struct virtio_crypto_op_data_req. +\item If the VIRTIO_CRYPTO_F_AEAD_STATELESS_MODE feature bit is negotiated= , the + device MUST parse the virtio_crypto_aead_data_req based on the \field{= opcode} + field in general header. +\item The device MUST copy the result of cryptographic operation in the ds= t_data[]. +\item The device MUST copy the authentication tag in the dst_data[] offset= the cipher result. +\item The device MUST set the \field{status} field in struct virtio_crypto= _inhdr to + one of the following values of enum VIRTIO_CRYPTO_STATUS: +\item When the \field{opcode} field is VIRTIO_CRYPTO_AEAD_DECRYPT, the dev= ice MUST + verify and return the verification result to the driver. +\begin{itemize*} +\item VIRTIO_CRYPTO_OK if the operation success. +\item VIRTIO_CRYPTO_NOTSUPP if the requested algorithm or operation is uns= upported. +\item VIRTIO_CRYPTO_BADMSG if the verification result is incorrect. +\item VIRTIO_CRYPTO_INVSESS if the session ID invalid when in session mode. +\item VIRTIO_CRYPTO_ERR if any failure not mentioned above occurs. +\end{itemize*} +\end{itemize*} --=20 2.7.4 From nobody Fri May 3 02:59:38 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1503734334528595.4689940165855; Sat, 26 Aug 2017 00:58:54 -0700 (PDT) Received: from localhost ([::1]:56462 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dlVzZ-0001Xd-DP for importer@patchew.org; Sat, 26 Aug 2017 03:58:53 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:33518) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dlVwp-0008Sl-8A for qemu-devel@nongnu.org; Sat, 26 Aug 2017 03:56:04 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dlVwl-0006Kp-Qp for qemu-devel@nongnu.org; Sat, 26 Aug 2017 03:56:03 -0400 Received: from szxga04-in.huawei.com ([45.249.212.190]:2303) by eggs.gnu.org with esmtps (TLS1.0:RSA_ARCFOUR_SHA1:16) (Exim 4.71) (envelope-from ) id 1dlVwl-0006Ht-7d for qemu-devel@nongnu.org; Sat, 26 Aug 2017 03:55:59 -0400 Received: from 172.30.72.60 (EHLO DGGEMS408-HUB.china.huawei.com) ([172.30.72.60]) by dggrg04-dlp.huawei.com (MOS 4.4.6-GA FastPath queued) with ESMTP id DFX65784; Sat, 26 Aug 2017 15:55:27 +0800 (CST) Received: from localhost (10.177.246.209) by DGGEMS408-HUB.china.huawei.com (10.3.19.208) with Microsoft SMTP Server id 14.3.301.0; Sat, 26 Aug 2017 15:55:16 +0800 From: "Longpeng(Mike)" To: , Date: Sat, 26 Aug 2017 15:53:34 +0800 Message-ID: <1503734014-239116-3-git-send-email-longpeng2@huawei.com> X-Mailer: git-send-email 1.8.4.msysgit.0 In-Reply-To: <1503734014-239116-1-git-send-email-longpeng2@huawei.com> References: <1503734014-239116-1-git-send-email-longpeng2@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.177.246.209] X-CFilter-Loop: Reflected X-Mirapoint-Virus-RAPID-Raw: score=unknown(0), refid=str=0001.0A090206.59A1296F.002D, ss=1, re=0.000, recu=0.000, reip=0.000, cl=1, cld=1, fgs=0, ip=0.0.0.0, so=2014-11-16 11:51:01, dmn=2013-03-21 17:37:32 X-Mirapoint-Loop-Id: 5b64fea320aebb32d57492c773a36fbb X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] [fuzzy] X-Received-From: 45.249.212.190 Subject: [Qemu-devel] [PATCH v19 2/2] virtio-crypto: Add conformance clauses X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: weidong.huang@huawei.com, mst@redhat.com, jasowang@redhat.com, john.griffin@intel.com, Varun.Sethi@freescale.com, denglingli@chinamobile.com, arei.gonglei@hotmail.com, agraf@suse.de, Gonglei , nmorey@kalray.eu, "Longpeng\(Mike\)" , vincent.jardin@6wind.com, Ola.Liljedahl@arm.com, luonengjun@huawei.com, xin.zeng@intel.com, liang.j.ma@intel.com, stefanha@redhat.com, Jani.Kokkonen@huawei.com, pasic@linux.vnet.ibm.com, brian.a.keating@intel.com, wangxinxin.wang@huawei.com, cohuck@redhat.com, mike.caraman@nxp.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Gonglei Add the conformance targets and clauses for virtio-crypto device. Signed-off-by: Gonglei Signed-off-by: Longpeng(Mike) --- conformance.tex | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/conformance.tex b/conformance.tex index 7b7df32..266a22f 100644 --- a/conformance.tex +++ b/conformance.tex @@ -145,6 +145,21 @@ An SCSI host driver MUST conform to the following norm= ative statements: \item \ref{drivernormative:Device Types / SCSI Host Device / Device Operat= ion / Device Operation: eventq} \end{itemize} =20 +\subsection{Crypto Driver Conformance}\label{sec:Conformance / Driver Conf= ormance / Crypto Driver Conformance} + +A Crypto driver MUST conform to the following normative statements: + +\begin{itemize} +\item \ref{drivernormative:Device Types / Crypto Device / Device configura= tion layout} +\item \ref{drivernormative:Device Types / Crypto Device / Device Initializ= ation} +\item \ref{drivernormative:Device Types / Crypto Device / Device Operation= / Control Virtqueue / Session operation / Session operation: create sessio= n} +\item \ref{drivernormative:Device Types / Crypto Device / Device Operation= / Control Virtqueue / Session operation / Session operation: destroy sessi= on} +\item \ref{drivernormative:Device Types / Crypto Device / Device Operation= / HASH Service operation} +\item \ref{drivernormative:Device Types / Crypto Device / Device Operation= / MAC Service operation} +\item \ref{drivernormative:Device Types / Crypto Device / Device Operation= / Symmetric algorithms Operation} +\item \ref{drivernormative:Device Types / Crypto Device / Device Operation= / AEAD Service operation} +\end{itemize} + \section{Device Conformance}\label{sec:Conformance / Device Conformance} =20 A device MUST conform to the following normative statements: @@ -265,6 +280,20 @@ An SCSI host device MUST conform to the following norm= ative statements: \item \ref{devicenormative:Device Types / SCSI Host Device / Device Operat= ion / Device Operation: eventq} \end{itemize} =20 +\subsection{Crypto Device Conformance}\label{sec:Conformance / Device Conf= ormance / Crypto Device Conformance} + +A Crypto device MUST conform to the following normative statements: + +\begin{itemize} +\item \ref{devicenormative:Device Types / Crypto Device / Device configura= tion layout} +\item \ref{devicenormative:Device Types / Crypto Device / Device Operation= / Control Virtqueue / Session operation / Session operation: create sessio= n} +\item \ref{devicenormative:Device Types / Crypto Device / Device Operation= / Control Virtqueue / Session operation / Session operation: destroy sessi= on} +\item \ref{devicenormative:Device Types / Crypto Device / Device Operation= / HASH Service operation} +\item \ref{devicenormative:Device Types / Crypto Device / Device Operation= / MAC Service operation} +\item \ref{devicenormative:Device Types / Crypto Device / Device Operation= / Symmetric algorithms Operation} +\item \ref{devicenormative:Device Types / Crypto Device / Device Operation= / AEAD Service operation} +\end{itemize} + \section{Legacy Interface: Transitional Device and Transitional Driver Conformance}\label{sec:Conformance / Legacy Interface: Transitional Device and=20 --=20 2.7.4