1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2016 Intel Corporation. 3 4SNOW 3G Crypto Poll Mode Driver 5=============================== 6 7The SNOW 3G PMD (**librte_pmd_snow3g**) provides poll mode crypto driver 8support for utilizing Intel Libsso library, which implements F8 and F9 functions 9for SNOW 3G UEA2 cipher and UIA2 hash algorithms. 10 11Features 12-------- 13 14SNOW 3G PMD has support for: 15 16Cipher algorithm: 17 18* RTE_CRYPTO_CIPHER_SNOW3G_UEA2 19 20Authentication algorithm: 21 22* RTE_CRYPTO_AUTH_SNOW3G_UIA2 23 24Limitations 25----------- 26 27* Chained mbufs are not supported. 28* SNOW 3G (UIA2) supported only if hash offset field is byte-aligned. 29* In-place bit-level operations for SNOW 3G (UEA2) are not supported 30 (if length and/or offset of data to be ciphered is not byte-aligned). 31 32Installation 33------------ 34 35To build DPDK with the SNOW3G_PMD the user is required to download 36the export controlled ``libsso_snow3g`` library, by registering in 37`Intel Resource & Design Center <https://www.intel.com/content/www/us/en/design/resource-design-center.html>`_. 38Once approval has been granted, the user needs to search for 39*Snow3G F8 F9 3GPP cryptographic algorithms Software Library* to download the 40library or directly through this `link <https://cdrdv2.intel.com/v1/dl/getContent/575867>`_. 41After downloading the library, the user needs to unpack and compile it 42on their system before building DPDK:: 43 44 make snow3G 45 46**Note**: When encrypting with SNOW3G UEA2, by default the library 47encrypts blocks of 4 bytes, regardless the number of bytes to 48be encrypted provided (which leads to a possible buffer overflow). 49To avoid this situation, it is necessary not to pass 503GPP_SAFE_BUFFERS as a compilation flag. 51For this, in the Makefile of the library, make sure that this flag 52is commented out.:: 53 54 #EXTRA_CFLAGS += -D_3GPP_SAFE_BUFFERS 55 56 57Initialization 58-------------- 59 60In order to enable this virtual crypto PMD, user must: 61 62* Export the environmental variable LIBSSO_SNOW3G_PATH with the path where 63 the library was extracted (snow3g folder). 64 65* Build the LIBSSO_SNOW3G library (explained in Installation section). 66 67* Set CONFIG_RTE_LIBRTE_PMD_SNOW3G=y in config/common_base. 68 69To use the PMD in an application, user must: 70 71* Call rte_vdev_init("crypto_snow3g") within the application. 72 73* Use --vdev="crypto_snow3g" in the EAL options, which will call rte_vdev_init() internally. 74 75The following parameters (all optional) can be provided in the previous two calls: 76 77* socket_id: Specify the socket where the memory for the device is going to be allocated 78 (by default, socket_id will be the socket where the core that is creating the PMD is running on). 79 80* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default). 81 82* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default). 83 84Example: 85 86.. code-block:: console 87 88 ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \ 89 -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2" 90