1.. BSD LICENSE 2 Copyright(c) 2015-2017 Intel Corporation. All rights reserved. 3 4 Redistribution and use in source and binary forms, with or without 5 modification, are permitted provided that the following conditions 6 are met: 7 8 * Redistributions of source code must retain the above copyright 9 notice, this list of conditions and the following disclaimer. 10 * Redistributions in binary form must reproduce the above copyright 11 notice, this list of conditions and the following disclaimer in 12 the documentation and/or other materials provided with the 13 distribution. 14 * Neither the name of Intel Corporation nor the names of its 15 contributors may be used to endorse or promote products derived 16 from this software without specific prior written permission. 17 18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 30AESN-NI Multi Buffer Crypto Poll Mode Driver 31============================================ 32 33 34The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver 35support for utilizing Intel multi buffer library, see the white paper 36`Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors 37<https://www-ssl.intel.com/content/www/us/en/intelligent-systems/intel-technology/fast-multi-buffer-ipsec-implementations-ia-processors-paper.html?wapkw=multi+buffer>`_. 38 39The AES-NI MB PMD has current only been tested on Fedora 21 64-bit with gcc. 40 41Features 42-------- 43 44AESNI MB PMD has support for: 45 46Cipher algorithms: 47 48* RTE_CRYPTO_CIPHER_AES128_CBC 49* RTE_CRYPTO_CIPHER_AES192_CBC 50* RTE_CRYPTO_CIPHER_AES256_CBC 51* RTE_CRYPTO_CIPHER_AES128_CTR 52* RTE_CRYPTO_CIPHER_AES192_CTR 53* RTE_CRYPTO_CIPHER_AES256_CTR 54* RTE_CRYPTO_CIPHER_AES_DOCSISBPI 55* RTE_CRYPTO_CIPHER_DES_CBC 56* RTE_CRYPTO_CIPHER_DES_DOCSISBPI 57 58Hash algorithms: 59 60* RTE_CRYPTO_HASH_MD5_HMAC 61* RTE_CRYPTO_HASH_SHA1_HMAC 62* RTE_CRYPTO_HASH_SHA224_HMAC 63* RTE_CRYPTO_HASH_SHA256_HMAC 64* RTE_CRYPTO_HASH_SHA384_HMAC 65* RTE_CRYPTO_HASH_SHA512_HMAC 66* RTE_CRYPTO_HASH_AES_XCBC_HMAC 67 68AEAD algorithms: 69 70* RTE_CRYPTO_AEAD_AES_CCM 71 72Limitations 73----------- 74 75* Chained mbufs are not supported. 76* Only in-place is currently supported (destination address is the same as source address). 77 78 79Installation 80------------ 81 82To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer 83library from `here <https://github.com/01org/intel-ipsec-mb>`_ 84and compile it on their user system before building DPDK. 85The latest version of the library supported by this PMD is v0.48, which 86can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.48.zip>`_. 87 88.. code-block:: console 89 90 make 91 92As a reference, the following table shows a mapping between the past DPDK versions 93and the Multi-Buffer library version supported by them: 94 95.. _table_aesni_mb_versions: 96 97.. table:: DPDK and Multi-Buffer library version compatibility 98 99 ============== ============================ 100 DPDK version Multi-buffer library version 101 ============== ============================ 102 2.2 - 16.11 0.43 - 0.44 103 17.02 0.44 104 17.05 - 17.08 0.45 - 0.48 105 17.11 0.47 - 0.48 106 18.02+ 0.48 107 ============== ============================ 108 109 110Initialization 111-------------- 112 113In order to enable this virtual crypto PMD, user must: 114 115* Export the environmental variable AESNI_MULTI_BUFFER_LIB_PATH with the path where 116 the library was extracted. 117 118* Build the multi buffer library (explained in Installation section). 119 120* Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base. 121 122To use the PMD in an application, user must: 123 124* Call rte_vdev_init("crypto_aesni_mb") within the application. 125 126* Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_vdev_init() internally. 127 128The following parameters (all optional) can be provided in the previous two calls: 129 130* socket_id: Specify the socket where the memory for the device is going to be allocated 131 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 132 133* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 134 135* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 136 137Example: 138 139.. code-block:: console 140 141 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \ 142 -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac" 143 144Extra notes 145----------- 146 147For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization 148Vector (IV): 149 150* 12 bytes: used mainly for IPSec, as it requires 12 bytes from the user, which internally 151 are appended the counter block (4 bytes), which is set to 1 for the first block 152 (no padding required from the user) 153 154* 16 bytes: when passing 16 bytes, the library will take them and use the last 4 bytes 155 as the initial counter block for the first block. 156