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