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 30ZUC Crypto Poll Mode Driver 31=========================== 32 33The ZUC PMD (**librte_pmd_zuc**) provides poll mode crypto driver 34support for utilizing Intel Libsso library, which implements F8 and F9 functions 35for ZUC EEA3 cipher and EIA3 hash algorithms. 36 37Features 38-------- 39 40ZUC PMD has support for: 41 42Cipher algorithm: 43 44* RTE_CRYPTO_CIPHER_ZUC_EEA3 45 46Authentication algorithm: 47 48* RTE_CRYPTO_AUTH_ZUC_EIA3 49 50Limitations 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 60Installation 61------------ 62 63To build DPDK with the ZUC_PMD the user is required to download 64the export controlled ``libsso_zuc`` library, by requesting it from 65`<https://networkbuilders.intel.com/network-technologies/dpdk>`_. 66Once approval has been granted, the user needs to log in 67`<https://networkbuilders.intel.com/dpdklogin>`_ 68and click on "ZUC Library" link, to download the library. 69After downloading the library, the user needs to unpack and compile it 70on their system before building DPDK:: 71 72 make 73 74Initialization 75-------------- 76 77In 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* Build the LIBSSO_ZUC library (explained in Installation section). 83 84* Build DPDK as follows: 85 86.. code-block:: console 87 88 make config T=x86_64-native-linuxapp-gcc 89 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_ZUC\)=n,\1=y,' build/.config 90 make 91 92To use the PMD in an application, user must: 93 94* Call rte_eal_vdev_init("crypto_zuc") within the application. 95 96* Use --vdev="crypto_zuc" in the EAL options, which will call rte_eal_vdev_init() internally. 97 98The following parameters (all optional) can be provided in the previous two calls: 99 100* socket_id: Specify the socket where the memory for the device is going to be allocated 101 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 102 103* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 104 105* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 106 107Example: 108 109.. code-block:: console 110 111 ./l2fwd-crypto -l 6 -n 4 --vdev="crypto_zuc,socket_id=1,max_nb_sessions=128" 112