doc/guides/cryptodevs/aesni_mb.rst

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