cryptodevs/zuc.rst

   1 ..  BSD LICENSE
   2     Copyright(c) 2016 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 ZUC Crypto Poll Mode Driver
  31 ===========================
  32
  33 The ZUC PMD (**librte_pmd_zuc**) provides poll mode crypto driver
  34 support for utilizing Intel Libsso library, which implements F8 and F9 functions
  35 for ZUC EEA3 cipher and EIA3 hash algorithms.
  36
  37 Features
  38 --------
  39
  40 ZUC PMD has support for:
  41
  42 Cipher algorithm:
  43
  44 * RTE_CRYPTO_CIPHER_ZUC_EEA3
  45
  46 Authentication algorithm:
  47
  48 * RTE_CRYPTO_AUTH_ZUC_EIA3
  49
  50 Limitations
  51 -----------
  52
  53 * Chained mbufs are not supported.
  54 * ZUC (EIA3) supported only if hash offset field is byte-aligned.
  55 * ZUC (EEA3) supported only if cipher length, cipher offset fields are byte-aligned.
  56 * ZUC PMD cannot be built as a shared library, due to limitations in
  57   in the underlying library.
  58
  59
  60 Installation
  61 ------------
  62
  63 To build DPDK with the ZUC_PMD the user is required to download
  64 the export controlled ``libsso_zuc`` library, by requesting it from
  65 `<https://networkbuilders.intel.com/network-technologies/dpdk>`_.
  66 Once approval has been granted, the user needs to log in
  67 `<https://networkbuilders.intel.com/dpdklogin>`_
  68 and click on "ZUC Library" link, to download the library.
  69 After downloading the library, the user needs to unpack and compile it
  70 on their system before building DPDK::
  71
  72    make
  73
  74 Initialization
  75 --------------
  76
  77 In order to enable this virtual crypto PMD, user must:
  78
  79 * Export the environmental variable LIBSSO_ZUC_PATH with the path where
  80   the library was extracted (zuc folder).
  81
  82 * Export the environmental variable LD_LIBRARY_PATH with the path
  83   where the built libsso library is (LIBSSO_ZUC_PATH/build).
  84
  85 * Build the LIBSSO_ZUC library (explained in Installation section).
  86
  87 * Build DPDK as follows:
  88
  89 .. code-block:: console
  90
  91         make config T=x86_64-native-linuxapp-gcc
  92         sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_ZUC\)=n,\1=y,' build/.config
  93         make
  94
  95 To use the PMD in an application, user must:
  96
  97 * Call rte_vdev_init("crypto_zuc") within the application.
  98
  99 * Use --vdev="crypto_zuc" in the EAL options, which will call rte_vdev_init() internally.
 100
 101 The following parameters (all optional) can be provided in the previous two calls:
 102
 103 * socket_id: Specify the socket where the memory for the device is going to be allocated
 104   (by default, socket_id will be the socket where the core that is creating the PMD is running on).
 105
 106 * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
 107
 108 * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
 109
 110 Example:
 111
 112 .. code-block:: console
 113
 114     ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \
 115     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"