.. BSD LICENSE Copyright(c) 2016 Intel Corporation. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Intel Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. KASUMI Crypto Poll Mode Driver =============================== The KASUMI PMD (**librte_pmd_kasumi**) provides poll mode crypto driver support for utilizing Intel Libsso library, which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms. Features -------- KASUMI PMD has support for: Cipher algorithm: * RTE_CRYPTO_SYM_CIPHER_KASUMI_F8 Authentication algorithm: * RTE_CRYPTO_SYM_AUTH_KASUMI_F9 Limitations ----------- * Chained mbufs are not supported. * KASUMI(F9) supported only if hash offset field is byte-aligned. * In-place bit-level operations for KASUMI(F8) are not supported (if length and/or offset of data to be ciphered is not byte-aligned). Installation ------------ To build DPDK with the KASUMI_PMD the user is required to download the export controlled ``libsso_kasumi`` library, by requesting it from ``_. Once approval has been granted, the user needs to log in ``_ and click on "Kasumi Bit Stream crypto library" link, to download the library. After downloading the library, the user needs to unpack and compile it on their system before building DPDK:: make kasumi Initialization -------------- In order to enable this virtual crypto PMD, user must: * Export the environmental variable LIBSSO_KASUMI_PATH with the path where the library was extracted (kasumi folder). * Build the LIBSSO library (explained in Installation section). * Set CONFIG_RTE_LIBRTE_PMD_KASUMI=y in config/common_base. To use the PMD in an application, user must: * Call rte_eal_vdev_init("cryptodev_kasumi_pmd") within the application. * Use --vdev="cryptodev_kasumi_pmd" in the EAL options, which will call rte_eal_vdev_init() internally. The following parameters (all optional) can be provided in the previous two calls: * socket_id: Specify the socket where the memory for the device is going to be allocated (by default, socket_id will be the socket where the core that is creating the PMD is running on). * max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). * max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). Example: .. code-block:: console ./l2fwd-crypto -c 40 -n 4 --vdev="cryptodev_kasumi_pmd,socket_id=1,max_nb_sessions=128"