snow3g.rst revision 97f17497
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(UEA2) supported only if cipher length, cipher offset fields are byte-aligned.
55* Snow3g(UIA2) supported only if hash length, hash offset fields are byte-aligned.
56
57Installation
58------------
59
60To build DPDK with the SNOW3G_PMD the user is required to download
61the export controlled ``libsso`` library, by requesting it from
62`<https://networkbuilders.intel.com/network-technologies/dpdk>`_,
63and compiling it on their system before building DPDK::
64
65   make -f Makefile_snow3g
66
67**Note**: If using a gcc version higher than 5.0, and compilation fails, apply the following patch:
68
69.. code-block:: diff
70
71   /libsso/src/snow3g/sso_snow3g.c
72
73   static inline void ClockFSM_4(sso_snow3gKeyState4_t *pCtx, __m128i *data)
74   {
75       __m128i F, R;
76   -    uint32_t K, L;
77   +    uint32_t K;
78   +    /* Declare unused if SNOW3G_WSM/SNB are defined */
79   +    uint32_t L __attribute__ ((unused)) = 0;
80
81        F = _mm_add_epi32(pCtx->LFSR_X[15], pCtx->FSM_X[0]);
82        R = _mm_xor_si128(pCtx->LFSR_X[5], pCtx->FSM_X[2]);
83
84   /libsso/include/sso_snow3g_internal.h
85
86   -inline void ClockFSM_1(sso_snow3gKeyState1_t *pCtx, uint32_t *data);
87   -inline void ClockLFSR_1(sso_snow3gKeyState1_t *pCtx);
88   -inline void sso_snow3gStateInitialize_1(sso_snow3gKeyState1_t * pCtx, sso_snow3g_key_schedule_t *pKeySched, uint8_t *pIV);
89   +void ClockFSM_1(sso_snow3gKeyState1_t *pCtx, uint32_t *data);
90   +void ClockLFSR_1(sso_snow3gKeyState1_t *pCtx);
91   +void sso_snow3gStateInitialize_1(sso_snow3gKeyState1_t * pCtx, sso_snow3g_key_schedule_t *pKeySched, uint8_t *pIV);
92
93
94Initialization
95--------------
96
97In order to enable this virtual crypto PMD, user must:
98
99* Export the environmental variable LIBSSO_PATH with the path where
100  the library was extracted.
101
102* Build the LIBSSO library (explained in Installation section).
103
104* Set CONFIG_RTE_LIBRTE_PMD_SNOW3G=y in config/common_base.
105
106To use the PMD in an application, user must:
107
108* Call rte_eal_vdev_init("cryptodev_snow3g_pmd") within the application.
109
110* Use --vdev="cryptodev_snow3g_pmd" in the EAL options, which will call rte_eal_vdev_init() internally.
111
112The following parameters (all optional) can be provided in the previous two calls:
113
114* socket_id: Specify the socket where the memory for the device is going to be allocated
115  (by default, socket_id will be the socket where the core that is creating the PMD is running on).
116
117* max_nb_queue_pairs: Specify the maximum number of queue pairs in the device (8 by default).
118
119* max_nb_sessions: Specify the maximum number of sessions that can be created (2048 by default).
120
121Example:
122
123.. code-block:: console
124
125    ./l2fwd-crypto -c 40 -n 4 --vdev="cryptodev_snow3g_pmd,socket_id=1,max_nb_sessions=128"
126