snow3g.rst revision 809f0800
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
30SNOW 3G Crypto Poll Mode Driver
31===============================
32
33The SNOW 3G PMD (**librte_pmd_snow3g**) provides poll mode crypto driver
34support for utilizing Intel Libsso library, which implements F8 and F9 functions
35for SNOW 3G UEA2 cipher and UIA2 hash algorithms.
36
37Features
38--------
39
40SNOW 3G PMD has support for:
41
42Cipher algorithm:
43
44* RTE_CRYPTO_SYM_CIPHER_SNOW3G_UEA2
45
46Authentication algorithm:
47
48* RTE_CRYPTO_SYM_AUTH_SNOW3G_UIA2
49
50Limitations
51-----------
52
53* Chained mbufs are not supported.
54* Snow3g(UIA2) supported only if hash offset field is byte-aligned.
55* In-place bit-level operations for Snow3g(UEA2) are not supported
56  (if length and/or offset of data to be ciphered is not byte-aligned).
57
58Installation
59------------
60
61To build DPDK with the KASUMI_PMD the user is required to download
62the export controlled ``libsso_snow3g`` library, by requesting it from
63`<https://networkbuilders.intel.com/network-technologies/dpdk>`_.
64Once approval has been granted, the user needs to log in
65`<https://networkbuilders.intel.com/dpdklogin>`_
66and click on "Snow3G Bit Stream crypto library" link, to download the library.
67After downloading the library, the user needs to unpack and compile it
68on their system before building DPDK::
69
70   make snow3G
71
72Initialization
73--------------
74
75In order to enable this virtual crypto PMD, user must:
76
77* Export the environmental variable LIBSSO_SNOW3G_PATH with the path where
78  the library was extracted (snow3g folder).
79
80* Build the LIBSSO_SNOW3G library (explained in Installation section).
81
82* Set CONFIG_RTE_LIBRTE_PMD_SNOW3G=y in config/common_base.
83
84To use the PMD in an application, user must:
85
86* Call rte_eal_vdev_init("cryptodev_snow3g_pmd") within the application.
87
88* Use --vdev="cryptodev_snow3g_pmd" in the EAL options, which will call rte_eal_vdev_init() internally.
89
90The following parameters (all optional) can be provided in the previous two calls:
91
92* socket_id: Specify the socket where the memory for the device is going to be allocated
93  (by default, socket_id will be the socket where the core that is creating the PMD is running on).
94
95* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
96
97* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
98
99Example:
100
101.. code-block:: console
102
103    ./l2fwd-crypto -c 40 -n 4 --vdev="cryptodev_snow3g_pmd,socket_id=1,max_nb_sessions=128"
104