1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2015-2018 Intel Corporation. 3 4AESN-NI Multi Buffer Crypto Poll Mode Driver 5============================================ 6 7 8The AESNI MB PMD (**librte_crypto_aesni_mb**) provides poll mode crypto driver 9support for utilizing Intel multi buffer library, see the white paper 10`Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors 11<https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_. 12 13The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc. 14 15The AES-NI MB PMD supports synchronous mode of operation with 16``rte_cryptodev_sym_cpu_crypto_process`` function call. 17 18Features 19-------- 20 21AESNI MB PMD has support for: 22 23Cipher algorithms: 24 25* RTE_CRYPTO_CIPHER_AES128_CBC 26* RTE_CRYPTO_CIPHER_AES192_CBC 27* RTE_CRYPTO_CIPHER_AES256_CBC 28* RTE_CRYPTO_CIPHER_AES128_CTR 29* RTE_CRYPTO_CIPHER_AES192_CTR 30* RTE_CRYPTO_CIPHER_AES256_CTR 31* RTE_CRYPTO_CIPHER_AES_DOCSISBPI 32* RTE_CRYPTO_CIPHER_DES_CBC 33* RTE_CRYPTO_CIPHER_3DES_CBC 34* RTE_CRYPTO_CIPHER_DES_DOCSISBPI 35* RTE_CRYPTO_CIPHER_AES128_ECB 36* RTE_CRYPTO_CIPHER_AES192_ECB 37* RTE_CRYPTO_CIPHER_AES256_ECB 38* RTE_CRYPTO_CIPHER_ZUC_EEA3 39* RTE_CRYPTO_CIPHER_SNOW3G_UEA2 40* RTE_CRYPTO_CIPHER_KASUMI_F8 41 42Hash algorithms: 43 44* RTE_CRYPTO_AUTH_MD5_HMAC 45* RTE_CRYPTO_AUTH_SHA1_HMAC 46* RTE_CRYPTO_AUTH_SHA224_HMAC 47* RTE_CRYPTO_AUTH_SHA256_HMAC 48* RTE_CRYPTO_AUTH_SHA384_HMAC 49* RTE_CRYPTO_AUTH_SHA512_HMAC 50* RTE_CRYPTO_AUTH_AES_XCBC_HMAC 51* RTE_CRYPTO_AUTH_AES_CMAC 52* RTE_CRYPTO_AUTH_AES_GMAC 53* RTE_CRYPTO_AUTH_SHA1 54* RTE_CRYPTO_AUTH_SHA224 55* RTE_CRYPTO_AUTH_SHA256 56* RTE_CRYPTO_AUTH_SHA384 57* RTE_CRYPTO_AUTH_SHA512 58* RTE_CRYPTO_AUTH_ZUC_EIA3 59* RTE_CRYPTO_AUTH_SNOW3G_UIA2 60* RTE_CRYPTO_AUTH_KASUMI_F9 61 62AEAD algorithms: 63 64* RTE_CRYPTO_AEAD_AES_CCM 65* RTE_CRYPTO_AEAD_AES_GCM 66* RTE_CRYPTO_AEAD_CHACHA20_POLY1305 67 68Protocol offloads: 69 70* RTE_SECURITY_PROTOCOL_DOCSIS 71 72Limitations 73----------- 74 75* Chained mbufs are not supported. 76* Out-of-place is not supported for combined Crypto-CRC DOCSIS security 77 protocol. 78* RTE_CRYPTO_CIPHER_DES_DOCSISBPI is not supported for combined Crypto-CRC 79 DOCSIS security protocol. 80 81 82Installation 83------------ 84 85To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer 86library from `here <https://github.com/01org/intel-ipsec-mb>`_ 87and compile it on their user system before building DPDK. 88The latest version of the library supported by this PMD is v0.55, which 89can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.55.zip>`_. 90 91.. code-block:: console 92 93 make 94 make install 95 96The library requires NASM to be built. Depending on the library version, it might 97require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14). 98 99NASM is packaged for different OS. However, on some OS the version is too old, 100so a manual installation is required. In that case, NASM can be downloaded from 101`NASM website <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_. 102Once it is downloaded, extract it and follow these steps: 103 104.. code-block:: console 105 106 ./configure 107 make 108 make install 109 110.. note:: 111 112 Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53. 113 If a lower GCC version than 5.0, the workaround proposed by the following link 114 should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_. 115 116As a reference, the following table shows a mapping between the past DPDK versions 117and the Multi-Buffer library version supported by them: 118 119.. _table_aesni_mb_versions: 120 121.. table:: DPDK and Multi-Buffer library version compatibility 122 123 ============== ============================ 124 DPDK version Multi-buffer library version 125 ============== ============================ 126 2.2 - 16.11 0.43 - 0.44 127 17.02 0.44 128 17.05 - 17.08 0.45 - 0.48 129 17.11 0.47 - 0.48 130 18.02 0.48 131 18.05 - 19.02 0.49 - 0.52 132 19.05 - 19.08 0.52 133 19.11+ 0.52 - 0.55 134 ============== ============================ 135 136 137Initialization 138-------------- 139 140In order to enable this virtual crypto PMD, user must: 141 142* Build the multi buffer library (explained in Installation section). 143 144To use the PMD in an application, user must: 145 146* Call rte_vdev_init("crypto_aesni_mb") within the application. 147 148* Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_vdev_init() internally. 149 150The following parameters (all optional) can be provided in the previous two calls: 151 152* socket_id: Specify the socket where the memory for the device is going to be allocated 153 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 154 155* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 156 157* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 158 159Example: 160 161.. code-block:: console 162 163 ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ 164 -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac" 165 166Extra notes 167----------- 168 169For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization 170Vector (IV): 171 172* 12 bytes: used mainly for IPsec, as it requires 12 bytes from the user, which internally 173 are appended the counter block (4 bytes), which is set to 1 for the first block 174 (no padding required from the user) 175 176* 16 bytes: when passing 16 bytes, the library will take them and use the last 4 bytes 177 as the initial counter block for the first block. 178