xref: /qemu/subprojects/libvhost-user/standard-headers/linux/virtio_crypto.h (revision 5551e3a88e74c49218a8fc2b28293a8db4a95253)

#ifndef _LINUX_VIRTIO_CRYPTO_H
#define _LINUX_VIRTIO_CRYPTO_H
/* This header is BSD licensed so anyone can use the definitions to implement
 * compatible drivers/servers.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of IBM nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE. */

#include "standard-headers/linux/types.h"
#include "standard-headers/linux/virtio_config.h"
#include "standard-headers/linux/virtio_types.h"


#define VIRTIO_CRYPTO_SERVICE_CIPHER 0
#define VIRTIO_CRYPTO_SERVICE_HASH 1
#define VIRTIO_CRYPTO_SERVICE_MAC  2
#define VIRTIO_CRYPTO_SERVICE_AEAD 3

#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)
    __virtio32 opcode;
    __virtio32 algo;
    __virtio32 flag;
    /* data virtqueue id */
    __virtio32 queue_id;
};

struct virtio_crypto_cipher_session_para {
#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
    __virtio32 algo;
    /* length of key */
    __virtio32 keylen;

#define VIRTIO_CRYPTO_OP_ENCRYPT  1
#define VIRTIO_CRYPTO_OP_DECRYPT  2
    /* encrypt or decrypt */
    __virtio32 op;
    __virtio32 padding;
};

struct virtio_crypto_session_input {
    /* Device-writable part */
    __virtio64 session_id;
    __virtio32 status;
    __virtio32 padding;
};

struct virtio_crypto_cipher_session_req {
    struct virtio_crypto_cipher_session_para para;
};

struct virtio_crypto_hash_session_para {
#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
    __virtio32 algo;
    /* hash result length */
    __virtio32 hash_result_len;
};

struct virtio_crypto_hash_create_session_req {
    struct virtio_crypto_hash_session_para para;
};

struct virtio_crypto_mac_session_para {
#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
    __virtio32 algo;
    /* hash result length */
    __virtio32 hash_result_len;
    /* length of authenticated key */
    __virtio32 auth_key_len;
    __virtio32 padding;
};

struct virtio_crypto_mac_create_session_req {
    struct virtio_crypto_mac_session_para para;
};

struct virtio_crypto_aead_session_para {
#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
    __virtio32 algo;
    /* length of key */
    __virtio32 key_len;
    /* digest result length */
    __virtio32 digest_result_len;
    /* length of the additional authenticated data (AAD) in bytes */
    __virtio32 aad_len;
    /* encrypt or decrypt, See above VIRTIO_CRYPTO_OP_* */
    __virtio32 op;
    __virtio32 padding;
};

struct virtio_crypto_aead_create_session_req {
    struct virtio_crypto_aead_session_para para;
};

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
    __virtio32 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
    __virtio32 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 */
    __virtio32 aad_len;
    __virtio32 padding;
};

struct virtio_crypto_alg_chain_session_req {
    struct virtio_crypto_alg_chain_session_para para;
};

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
    __virtio32 op_type;
    __virtio32 padding;
};

struct virtio_crypto_destroy_session_req {
    /* Device-readable part */
    __virtio64  session_id;
};

/* The request of the control viritqueue's packet */
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;
};

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)
    __virtio32 opcode;
    /* algo should be service-specific algorithms */
    __virtio32 algo;
    /* session_id should be service-specific algorithms */
    __virtio64 session_id;
    /* control flag to control the request */
    __virtio32 flag;
    __virtio32 padding;
};

struct virtio_crypto_cipher_para {
    /*
     * Byte Length of valid IV/Counter
     *
     * - For block ciphers in CBC or F8 mode, or for Kasumi in F8 mode, or for
     *   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).
     * - 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.
     */
    __virtio32 iv_len;
    /* length of source data */
    __virtio32 src_data_len;
    /* length of dst data */
    __virtio32 dst_data_len;
    __virtio32 padding;
};

struct virtio_crypto_hash_para {
    /* length of source data */
    __virtio32 src_data_len;
    /* hash result length */
    __virtio32 hash_result_len;
};

struct virtio_crypto_mac_para {
    struct virtio_crypto_hash_para hash;
};

struct virtio_crypto_aead_para {
    /*
     * Byte Length of valid IV data pointed to by the below iv_addr
     * parameter.
     *
     * - For GCM mode, this is either 12 (for 96-bit IVs) or 16, in which
     *   case iv_addr points to J0.
     * - For CCM mode, this is the length of the nonce, which can be in the
     *   range 7 to 13 inclusive.
     */
    __virtio32 iv_len;
    /* length of additional auth data */
    __virtio32 aad_len;
    /* length of source data */
    __virtio32 src_data_len;
    /* length of dst data */
    __virtio32 dst_data_len;
};

struct virtio_crypto_cipher_data_req {
    /* Device-readable part */
    struct virtio_crypto_cipher_para para;
};

struct virtio_crypto_hash_data_req {
    /* Device-readable part */
    struct virtio_crypto_hash_para para;
};

struct virtio_crypto_mac_data_req {
    /* Device-readable part */
    struct virtio_crypto_mac_para para;
};

struct virtio_crypto_alg_chain_data_para {
    __virtio32 iv_len;
    /* Length of source data */
    __virtio32 src_data_len;
    /* Length of destination data */
    __virtio32 dst_data_len;
    /* Starting point for cipher processing in source data */
    __virtio32 cipher_start_src_offset;
    /* Length of the source data that the cipher will be computed on */
    __virtio32 len_to_cipher;
    /* Starting point for hash processing in source data */
    __virtio32 hash_start_src_offset;
    /* Length of the source data that the hash will be computed on */
    __virtio32 len_to_hash;
    /* Length of the additional auth data */
    __virtio32 aad_len;
    /* Length of the hash result */
    __virtio32 hash_result_len;
    __virtio32 reserved;
};

struct virtio_crypto_alg_chain_data_req {
    /* Device-readable part */
    struct virtio_crypto_alg_chain_data_para para;
};

struct virtio_crypto_sym_data_req {
    union {
        struct virtio_crypto_cipher_data_req cipher;
        struct virtio_crypto_alg_chain_data_req chain;
    } u;

    /* See above VIRTIO_CRYPTO_SYM_OP_* */
    __virtio32 op_type;
    __virtio32 padding;
};

struct virtio_crypto_aead_data_req {
    /* Device-readable part */
    struct virtio_crypto_aead_para para;
};

/* The request of the data viritqueue's packet */
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;
};

#define VIRTIO_CRYPTO_OK        0
#define VIRTIO_CRYPTO_ERR       1
#define VIRTIO_CRYPTO_BADMSG    2
#define VIRTIO_CRYPTO_NOTSUPP   3
#define VIRTIO_CRYPTO_INVSESS   4 /* Invaild session id */

/* The accelerator hardware is ready */
#define VIRTIO_CRYPTO_S_HW_READY  (1 << 0)
#define VIRTIO_CRYPTO_S_STARTED  (1 << 1)

struct virtio_crypto_config {
    /* See VIRTIO_CRYPTO_* above */
    __virtio32  status;

    /*
     * Maximum number of data queue legal values are between 1 and 0x8000
     */
    __virtio32  max_dataqueues;

    /* Specifies the services mask which the devcie support,
       see VIRTIO_CRYPTO_SERVICE_* above */
    __virtio32 crypto_services;

    /* Detailed algorithms mask */
    __virtio32 cipher_algo_l;
    __virtio32 cipher_algo_h;
    __virtio32 hash_algo;
    __virtio32 mac_algo_l;
    __virtio32 mac_algo_h;
    __virtio32 aead_algo;

    /* Maximum length of cipher key */
    uint32_t max_cipher_key_len;
    /* Maximum length of authenticated key */
    uint32_t max_auth_key_len;

    __virtio32 reserve;

    /* The maximum size of per request's content */
    __virtio64 max_size;
};

struct virtio_crypto_inhdr {
    /* See VIRTIO_CRYPTO_* above */
    uint8_t status;
};

#endif /* _LINUX_VIRTIO_CRYPTO_H */