doc/guides/cryptodevs/aesni_mb.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2015-2017 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 Features
  16 --------
  17
  18 AESNI MB PMD has support for:
  19
  20 Cipher algorithms:
  21
  22 * RTE_CRYPTO_CIPHER_AES128_CBC
  23 * RTE_CRYPTO_CIPHER_AES192_CBC
  24 * RTE_CRYPTO_CIPHER_AES256_CBC
  25 * RTE_CRYPTO_CIPHER_AES128_CTR
  26 * RTE_CRYPTO_CIPHER_AES192_CTR
  27 * RTE_CRYPTO_CIPHER_AES256_CTR
  28 * RTE_CRYPTO_CIPHER_AES_DOCSISBPI
  29 * RTE_CRYPTO_CIPHER_DES_CBC
  30 * RTE_CRYPTO_CIPHER_DES_DOCSISBPI
  31
  32 Hash algorithms:
  33
  34 * RTE_CRYPTO_HASH_MD5_HMAC
  35 * RTE_CRYPTO_HASH_SHA1_HMAC
  36 * RTE_CRYPTO_HASH_SHA224_HMAC
  37 * RTE_CRYPTO_HASH_SHA256_HMAC
  38 * RTE_CRYPTO_HASH_SHA384_HMAC
  39 * RTE_CRYPTO_HASH_SHA512_HMAC
  40 * RTE_CRYPTO_HASH_AES_XCBC_HMAC
  41
  42 AEAD algorithms:
  43
  44 * RTE_CRYPTO_AEAD_AES_CCM
  45
  46 Limitations
  47 -----------
  48
  49 * Chained mbufs are not supported.
  50 * Only in-place is currently supported (destination address is the same as source address).
  51
  52
  53 Installation
  54 ------------
  55
  56 To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer
  57 library from `here <https://github.com/01org/intel-ipsec-mb>`_
  58 and compile it on their user system before building DPDK.
  59 The latest version of the library supported by this PMD is v0.48, which
  60 can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.48.zip>`_.
  61
  62 .. code-block:: console
  63
  64         make
  65
  66 As a reference, the following table shows a mapping between the past DPDK versions
  67 and the Multi-Buffer library version supported by them:
  68
  69 .. _table_aesni_mb_versions:
  70
  71 .. table:: DPDK and Multi-Buffer library version compatibility
  72
  73    ==============  ============================
  74    DPDK version    Multi-buffer library version
  75    ==============  ============================
  76    2.2 - 16.11     0.43 - 0.44
  77    17.02           0.44
  78    17.05 - 17.08   0.45 - 0.48
  79    17.11           0.47 - 0.48
  80    18.02+          0.48
  81    ==============  ============================
  82
  83
  84 Initialization
  85 --------------
  86
  87 In order to enable this virtual crypto PMD, user must:
  88
  89 * Export the environmental variable AESNI_MULTI_BUFFER_LIB_PATH with the path where
  90   the library was extracted.
  91
  92 * Build the multi buffer library (explained in Installation section).
  93
  94 * Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base.
  95
  96 To use the PMD in an application, user must:
  97
  98 * Call rte_vdev_init("crypto_aesni_mb") within the application.
  99
 100 * Use --vdev="crypto_aesni_mb" in the EAL options, which will call rte_vdev_init() internally.
 101
 102 The following parameters (all optional) can be provided in the previous two calls:
 103
 104 * socket_id: Specify the socket where the memory for the device is going to be allocated
 105   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
 106
 107 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
 108
 109 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
 110
 111 Example:
 112
 113 .. code-block:: console
 114
 115     ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
 116     -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac"
 117
 118 Extra notes
 119 -----------
 120
 121 For AES Counter mode (AES-CTR), the library supports two different sizes for Initialization
 122 Vector (IV):
 123
 124 * 12 bytes: used mainly for IPSec, as it requires 12 bytes from the user, which internally
 125   are appended the counter block (4 bytes), which is set to 1 for the first block
 126   (no padding required from the user)
 127
 128 * 16 bytes: when passing 16 bytes, the library will take them and use the last 4 bytes
 129   as the initial counter block for the first block.