doc/guides/cryptodevs/aesni_mb.rst

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